Blame - docs/dyn/memcache_v1beta2.projects.locations.instances.html - platform/external/python/google-api-python-client

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

[diff] [blame^]

93

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

94

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

95

96

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

99

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

100

<p class="firstline">Updates an existing Instance in a given project and location.</p>

101

102

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

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>

104

105

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

106

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

107

108

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

109

<p class="firstline">Updates the defined Memcached Parameters for an existing Instance.</p>

110

<h3>Method Details</h3>

111

112

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

113

<pre>ApplyParameters will update current set of Parameters to the set of

114

specified nodes of the Memcached Instance.

115

116

Args:

117

name: string, Required. Resource name of the Memcached instance for which parameter group updates

118

should be applied. (required)

119

body: object, The request body.

120

The object takes the form of:

121

122

{ # Request for ApplyParameters.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

123

"nodeIds": [ # Nodes to which we should apply the instance-level parameter group.

124

"A String",

125

],

Bu Sun Kim

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

[diff] [blame^]

126

"applyAll": True or False, # Whether to apply instance-level parameter group to all nodes. If set to

127

# true, will explicitly restrict users from specifying any nodes, and apply

128

# parameter group updates to all nodes within the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

129

}

130

131

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

138

139

{ # This resource represents a long-running operation that is the result of a

140

# network API call.

Bu Sun Kim

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

[diff] [blame^]

141

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

142

# different programming environments, including REST APIs and RPC APIs. It is

143

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

144

# three pieces of data: error code, error message, and error details.

145

#

146

# You can find out more about this error model and how to work with it in the

147

# [API Design Guide](https://cloud.google.com/apis/design/errors).

148

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

149

"details": [ # A list of messages that carry the error details. There is a common set of

150

# message types for APIs to use.

151

{

152

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

153

},

154

],

155

"message": "A String", # A developer-facing error message, which should be in English. Any

156

# user-facing error message should be localized and sent in the

157

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

158

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

159

"response": { # The normal response of the operation in case of success. If the original

160

# method returns no data on success, such as `Delete`, the response is

161

# `google.protobuf.Empty`. If the original method is standard

162

# `Get`/`Create`/`Update`, the response should be the resource. For other

163

# methods, the response should have the type `XxxResponse`, where `Xxx`

164

# is the original method name. For example, if the original method name

165

# is `TakeSnapshot()`, the inferred response type is

166

# `TakeSnapshotResponse`.

167

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

168

},

169

"name": "A String", # The server-assigned name, which is only unique within the same service that

170

# originally returns it. If you use the default HTTP mapping, the

171

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

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

[diff] [blame^]

172

"metadata": { # Service-specific metadata associated with the operation. It typically

173

# contains progress information and common metadata such as create time.

174

# Some services might not provide such metadata. Any method that returns a

175

# long-running operation should document the metadata type, if any.

176

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

177

},

Bu Sun Kim

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

[diff] [blame^]

178

"done": True or False, # If the value is `false`, it means the operation is still in progress.

179

# If `true`, the operation is completed, and either `error` or `response` is

180

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>

186

<pre>Creates a new Instance in a given project and location.

187

188

Args:

189

parent: string, Required. The resource name of the instance location using the form:

190

`projects/{project_id}/locations/{location_id}`

191

where `location_id` refers to a GCP region (required)

192

body: object, The request body.

193

The object takes the form of:

194

195

{

Bu Sun Kim

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

[diff] [blame^]

196

"parameters": { # Optional: User defined parameters to apply to the memcached process

197

# on each node.

198

"id": "A String", # Output only. The unique ID associated with this set of parameters. Users

199

# can use this id to determine if the parameters associated with the instance

200

# differ from the parameters associated with the nodes and any action needs

201

# to be taken to apply parameters on nodes.

202

"params": { # User defined set of parameters to use in the memcached process.

203

"a_key": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

204

},

205

},

Bu Sun Kim

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

[diff] [blame^]

206

"zones": [ # Zones where Memcached nodes should be provisioned in.

207

# Memcached nodes will be equally distributed across these zones. If not

208

# provided, the service will by default create nodes in all zones in the

209

# region for the instance.

210

"A String",

211

],

212

"nodeCount": 42, # Required. Number of nodes in the Memcached instance.

213

"instanceMessages": [ # List of messages that describe current statuses of memcached instance.

214

{

215

"message": "A String", # Message on memcached instance which will be exposed to users.

216

"code": "A String", # A code that correspond to one type of user-facing message.

217

},

218

],

219

"discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API

220

"createTime": "A String", # Output only. The time the instance was created.

221

"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance.

222

# System automatically determines the full memcached version for an instance

223

# based on the input MemcacheVersion.

224

# The full version format will be "memcached-1.5.16".

225

"labels": { # Resource labels to represent user-provided metadata.

226

# Refer to cloud documentation on labels for more details.

227

# https://cloud.google.com/compute/docs/labeling-resources

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

228

"a_key": "A String",

229

},

Bu Sun Kim

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

[diff] [blame^]

230

"displayName": "A String", # User provided name for the instance only used for display

231

# purposes. Cannot be more than 80 characters.

232

"memcacheNodes": [ # Output only. List of Memcached nodes.

233

# Refer to [Node] message for more details.

234

{

235

"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not

236

# include project or location like the Memcached instance name.

237

"parameters": { # User defined parameters currently applied to the node.

238

"id": "A String", # Output only. The unique ID associated with this set of parameters. Users

239

# can use this id to determine if the parameters associated with the instance

240

# differ from the parameters associated with the nodes and any action needs

241

# to be taken to apply parameters on nodes.

242

"params": { # User defined set of parameters to use in the memcached process.

"a_key": "A String",

},

},

"state": "A String", # Output only. Current state of the Memcached node.

247

"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.

248

"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the

249

# clients to connect to the Memcached server on this node.

250

"port": 42, # Output only. The port number of the Memcached server on this node.

251

},

252

],

253

"state": "A String", # Output only. The state of this Memcached instance.

254

"memcacheVersion": "A String", # The major version of Memcached software.

255

# If not provided, latest supported version will be used. Currently the

256

# latest supported major version is MEMCACHE_1_5.

257

# The minor version will be automatically determined by our system based on

258

# the latest supported minor version.

259

"name": "A String", # Required. Unique name of the resource in this scope including project and

260

# location using the form:

261

# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

262

#

263

# Note: Memcached instances are managed and addressed at regional level so

264

# location_id here refers to a GCP region; however, users may choose which

265

# zones Memcached nodes within an instances should be provisioned in.

266

# Refer to [zones] field for more details.

267

"updateTime": "A String", # Output only. The time the instance was updated.

268

"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.

269

"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.

270

"cpuCount": 42, # Required. Number of cpus per Memcached node.

271

},

272

"authorizedNetwork": "A String", # The full name of the Google Compute Engine

273

# [network](https://cloud.google.com/vpc/docs/vpc) to which the

274

# instance is connected. If left unspecified, the `default` network

275

# will be used.

276

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

277

278

instanceId: string, Required. The logical name of the Memcached instance in the user

279

project with the following restrictions:

280

281

* Must contain only lowercase letters, numbers, and hyphens.

282

* Must start with a letter.

283

* Must be between 1-40 characters.

284

* Must end with a number or a letter.

285

* Must be unique within the user project / location

286

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

293

294

{ # This resource represents a long-running operation that is the result of a

295

# network API call.

Bu Sun Kim

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

[diff] [blame^]

296

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

297

# different programming environments, including REST APIs and RPC APIs. It is

298

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

299

# three pieces of data: error code, error message, and error details.

300

#

301

# You can find out more about this error model and how to work with it in the

302

# [API Design Guide](https://cloud.google.com/apis/design/errors).

303

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

304

"details": [ # A list of messages that carry the error details. There is a common set of

305

# message types for APIs to use.

306

{

307

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

308

},

309

],

310

"message": "A String", # A developer-facing error message, which should be in English. Any

311

# user-facing error message should be localized and sent in the

312

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

313

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

314

"response": { # The normal response of the operation in case of success. If the original

315

# method returns no data on success, such as `Delete`, the response is

316

# `google.protobuf.Empty`. If the original method is standard

317

# `Get`/`Create`/`Update`, the response should be the resource. For other

318

# methods, the response should have the type `XxxResponse`, where `Xxx`

319

# is the original method name. For example, if the original method name

320

# is `TakeSnapshot()`, the inferred response type is

321

# `TakeSnapshotResponse`.

322

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

323

},

324

"name": "A String", # The server-assigned name, which is only unique within the same service that

325

# originally returns it. If you use the default HTTP mapping, the

326

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

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

[diff] [blame^]

327

"metadata": { # Service-specific metadata associated with the operation. It typically

328

# contains progress information and common metadata such as create time.

329

# Some services might not provide such metadata. Any method that returns a

330

# long-running operation should document the metadata type, if any.

331

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

332

},

Bu Sun Kim

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

[diff] [blame^]

333

"done": True or False, # If the value is `false`, it means the operation is still in progress.

334

# If `true`, the operation is completed, and either `error` or `response` is

335

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

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

341

<pre>Deletes a single Instance.

342

343

Args:

344

name: string, Required. Memcached instance resource name in the format:

345

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

346

where `location_id` refers to a GCP region (required)

347

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

354

355

{ # This resource represents a long-running operation that is the result of a

356

# network API call.

Bu Sun Kim

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

[diff] [blame^]

357

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

358

# different programming environments, including REST APIs and RPC APIs. It is

359

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

360

# three pieces of data: error code, error message, and error details.

361

#

362

# You can find out more about this error model and how to work with it in the

363

# [API Design Guide](https://cloud.google.com/apis/design/errors).

364

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

365

"details": [ # A list of messages that carry the error details. There is a common set of

366

# message types for APIs to use.

367

{

368

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

369

},

370

],

371

"message": "A String", # A developer-facing error message, which should be in English. Any

372

# user-facing error message should be localized and sent in the

373

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

374

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

375

"response": { # The normal response of the operation in case of success. If the original

376

# method returns no data on success, such as `Delete`, the response is

377

# `google.protobuf.Empty`. If the original method is standard

378

# `Get`/`Create`/`Update`, the response should be the resource. For other

379

# methods, the response should have the type `XxxResponse`, where `Xxx`

380

# is the original method name. For example, if the original method name

381

# is `TakeSnapshot()`, the inferred response type is

382

# `TakeSnapshotResponse`.

383

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

384

},

385

"name": "A String", # The server-assigned name, which is only unique within the same service that

386

# originally returns it. If you use the default HTTP mapping, the

387

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

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

[diff] [blame^]

388

"metadata": { # Service-specific metadata associated with the operation. It typically

389

# contains progress information and common metadata such as create time.

390

# Some services might not provide such metadata. Any method that returns a

391

# long-running operation should document the metadata type, if any.

392

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

393

},

Bu Sun Kim

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

[diff] [blame^]

394

"done": True or False, # If the value is `false`, it means the operation is still in progress.

395

# If `true`, the operation is completed, and either `error` or `response` is

396

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

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

402

<pre>Gets details of a single Instance.

403

404

Args:

405

name: string, Required. Memcached instance resource name in the format:

406

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

407

where `location_id` refers to a GCP region (required)

408

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

415

416

{

Bu Sun Kim

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

[diff] [blame^]

417

"parameters": { # Optional: User defined parameters to apply to the memcached process

418

# on each node.

419

"id": "A String", # Output only. The unique ID associated with this set of parameters. Users

420

# can use this id to determine if the parameters associated with the instance

421

# differ from the parameters associated with the nodes and any action needs

422

# to be taken to apply parameters on nodes.

423

"params": { # User defined set of parameters to use in the memcached process.

424

"a_key": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

425

},

426

},

Bu Sun Kim

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

[diff] [blame^]

427

"zones": [ # Zones where Memcached nodes should be provisioned in.

428

# Memcached nodes will be equally distributed across these zones. If not

429

# provided, the service will by default create nodes in all zones in the

430

# region for the instance.

431

"A String",

432

],

433

"nodeCount": 42, # Required. Number of nodes in the Memcached instance.

434

"instanceMessages": [ # List of messages that describe current statuses of memcached instance.

435

{

436

"message": "A String", # Message on memcached instance which will be exposed to users.

437

"code": "A String", # A code that correspond to one type of user-facing message.

438

},

439

],

440

"discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API

441

"createTime": "A String", # Output only. The time the instance was created.

442

"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance.

443

# System automatically determines the full memcached version for an instance

444

# based on the input MemcacheVersion.

445

# The full version format will be "memcached-1.5.16".

446

"labels": { # Resource labels to represent user-provided metadata.

447

# Refer to cloud documentation on labels for more details.

448

# https://cloud.google.com/compute/docs/labeling-resources

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

449

"a_key": "A String",

450

},

Bu Sun Kim

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

[diff] [blame^]

451

"displayName": "A String", # User provided name for the instance only used for display

452

# purposes. Cannot be more than 80 characters.

453

"memcacheNodes": [ # Output only. List of Memcached nodes.

454

# Refer to [Node] message for more details.

455

{

456

"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not

457

# include project or location like the Memcached instance name.

458

"parameters": { # User defined parameters currently applied to the node.

459

"id": "A String", # Output only. The unique ID associated with this set of parameters. Users

460

# can use this id to determine if the parameters associated with the instance

461

# differ from the parameters associated with the nodes and any action needs

462

# to be taken to apply parameters on nodes.

463

"params": { # User defined set of parameters to use in the memcached process.

"a_key": "A String",

},

},

"state": "A String", # Output only. Current state of the Memcached node.

468

"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.

469

"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the

470

# clients to connect to the Memcached server on this node.

471

"port": 42, # Output only. The port number of the Memcached server on this node.

472

},

473

],

474

"state": "A String", # Output only. The state of this Memcached instance.

475

"memcacheVersion": "A String", # The major version of Memcached software.

476

# If not provided, latest supported version will be used. Currently the

477

# latest supported major version is MEMCACHE_1_5.

478

# The minor version will be automatically determined by our system based on

479

# the latest supported minor version.

480

"name": "A String", # Required. Unique name of the resource in this scope including project and

481

# location using the form:

482

# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

483

#

484

# Note: Memcached instances are managed and addressed at regional level so

485

# location_id here refers to a GCP region; however, users may choose which

486

# zones Memcached nodes within an instances should be provisioned in.

487

# Refer to [zones] field for more details.

488

"updateTime": "A String", # Output only. The time the instance was updated.

489

"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.

490

"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.

491

"cpuCount": 42, # Required. Number of cpus per Memcached node.

492

},

493

"authorizedNetwork": "A String", # The full name of the Google Compute Engine

494

# [network](https://cloud.google.com/vpc/docs/vpc) to which the

495

# instance is connected. If left unspecified, the `default` network

496

# will be used.

497

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

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

502

<pre>Gets the access control policy for a resource.

503

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

508

See the operation documentation for the appropriate value for this field. (required)

509

options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.

510

511

Valid values are 0, 1, and 3. Requests specifying an invalid value will be

512

rejected.

513

514

Requests for policies with any conditional bindings must specify version 3.

515

Policies without any conditional bindings may specify any valid value or

516

leave the field unset.

517

518

To learn which resources support conditions in their IAM policies, see the

519

[IAM

520

documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

521

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

528

529

{ # An Identity and Access Management (IAM) policy, which specifies access

530

# controls for Google Cloud resources.

531

#

532

#

533

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

534

# `members` to a single `role`. Members can be user accounts, service accounts,

535

# Google groups, and domains (such as G Suite). A `role` is a named list of

536

# permissions; each `role` can be an IAM predefined role or a user-created

537

# custom role.

538

#

539

# For some types of Google Cloud resources, a `binding` can also specify a

540

# `condition`, which is a logical expression that allows access to a resource

541

# only if the expression evaluates to `true`. A condition can add constraints

542

# based on attributes of the request, the resource, or both. To learn which

543

# resources support conditions in their IAM policies, see the

544

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

552

# "members": [

553

# "user:mike@example.com",

554

# "group:admins@example.com",

555

# "domain:google.com",

556

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

561

# "members": [

562

# "user:eve@example.com"

563

# ],

564

# "condition": {

565

# "title": "expirable access",

566

# "description": "Does not grant access after Sep 2020",

567

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

580

# - group:admins@example.com

581

# - domain:google.com

582

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

583

# role: roles/resourcemanager.organizationAdmin

584

# - members:

585

# - user:eve@example.com

586

# role: roles/resourcemanager.organizationViewer

587

# condition:

588

# title: expirable access

589

# description: Does not grant access after Sep 2020

590

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

591

# - etag: BwWWja0YfJA=

592

# - version: 3

593

#

594

# For a description of IAM and its features, see the

595

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame^]

596

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

597

{ # Specifies the audit configuration for a service.

598

# The configuration determines which permission types are logged, and what

599

# identities, if any, are exempted from logging.

600

# An AuditConfig must have one or more AuditLogConfigs.

601

#

602

# If there are AuditConfigs for both `allServices` and a specific service,

603

# the union of the two AuditConfigs is used for that service: the log_types

604

# specified in each AuditConfig are enabled, and the exempted_members in each

605

# AuditLogConfig are exempted.

606

#

607

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

613

# "audit_log_configs": [

614

# {

615

# "log_type": "DATA_READ",

616

# "exempted_members": [

617

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

622

# },

623

# {

624

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com",

630

# "audit_log_configs": [

631

# {

632

# "log_type": "DATA_READ"

633

# },

634

# {

635

# "log_type": "DATA_WRITE",

636

# "exempted_members": [

637

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

646

# logging. It also exempts jose@example.com from DATA_READ logging, and

647

# aliya@example.com from DATA_WRITE logging.

648

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

649

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

654

# {

655

# "log_type": "DATA_READ",

656

# "exempted_members": [

657

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

667

# jose@example.com from DATA_READ logging.

668

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

669

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

670

# permission.

671

# Follows the same format of Binding.members.

"A String",

],

},

],

"service": "A String", # Specifies a service that will be enabled for audit logging.

677

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

678

# `allServices` is a special value that covers all services.

679

},

680

],

681

"version": 42, # Specifies the format of the policy.

682

#

683

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

684

# are rejected.

685

#

686

# Any operation that affects conditional role bindings must specify version

687

# `3`. This requirement applies to the following operations:

688

#

689

# * Getting a policy that includes a conditional role binding

690

# * Adding a conditional role binding to a policy

691

# * Changing a conditional role binding in a policy

692

# * Removing any role binding, with or without a condition, from a policy

693

# that includes conditions

694

#

695

# **Important:** If you use IAM Conditions, you must include the `etag` field

696

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

697

# you to overwrite a version `3` policy with a version `1` policy, and all of

698

# the conditions in the version `3` policy are lost.

699

#

700

# If a policy does not include any conditions, operations on that policy may

701

# specify any valid version or leave the field unset.

702

#

703

# To learn which resources support conditions in their IAM policies, see the

704

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

705

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

706

# `condition` that determines how and when the `bindings` are applied. Each

707

# of the `bindings` must contain at least one member.

708

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

709

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

710

#

711

# If the condition evaluates to `true`, then this binding applies to the

712

# current request.

713

#

714

# If the condition evaluates to `false`, then this binding does not apply to

715

# the current request. However, a different role binding might grant the same

716

# role to one or more of the members in this binding.

717

#

718

# To learn which resources support conditions in their IAM policies, see the

719

# [IAM

720

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

721

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

722

# are documented at https://github.com/google/cel-spec.

723

#

724

# Example (Comparison):

725

#

726

# title: "Summary size limit"

727

# description: "Determines if a summary is less than 100 chars"

728

# expression: "document.summary.size() < 100"

729

#

730

# Example (Equality):

731

#

732

# title: "Requestor is owner"

733

# description: "Determines if requestor is the document owner"

734

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

739

# description: "Determine whether the document should be publicly visible"

740

# expression: "document.type != 'private' && document.type != 'internal'"

741

#

742

# Example (Data Manipulation):

743

#

744

# title: "Notification string"

745

# description: "Create a notification string with a timestamp."

746

# expression: "'New message received at ' + string(document.create_time)"

747

#

748

# The exact variables and functions that may be referenced within an expression

749

# are determined by the service that evaluates it. See the service

750

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame^]

751

"description": "A String", # Optional. Description of the expression. This is a longer text which

752

# describes the expression, e.g. when hovered over it in a UI.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

753

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

754

# its purpose. This can be used e.g. in UIs which allow to enter the

755

# expression.

Bu Sun Kim

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

[diff] [blame^]

756

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

757

# syntax.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

758

"location": "A String", # Optional. String indicating the location of the expression for error

759

# reporting, e.g. a file name and a position in the file.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

760

},

761

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

762

# `members` can have the following values:

763

#

764

# * `allUsers`: A special identifier that represents anyone who is

765

# on the internet; with or without a Google account.

766

#

767

# * `allAuthenticatedUsers`: A special identifier that represents anyone

768

# who is authenticated with a Google account or a service account.

769

#

770

# * `user:{emailid}`: An email address that represents a specific Google

771

# account. For example, `alice@example.com` .

772

#

773

#

774

# * `serviceAccount:{emailid}`: An email address that represents a service

775

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

776

#

777

# * `group:{emailid}`: An email address that represents a Google group.

778

# For example, `admins@example.com`.

779

#

780

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

781

# identifier) representing a user that has been recently deleted. For

782

# example, `alice@example.com?uid=123456789012345678901`. If the user is

783

# recovered, this value reverts to `user:{emailid}` and the recovered user

784

# retains the role in the binding.

785

#

786

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

787

# unique identifier) representing a service account that has been recently

788

# deleted. For example,

789

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

790

# If the service account is undeleted, this value reverts to

791

# `serviceAccount:{emailid}` and the undeleted service account retains the

792

# role in the binding.

793

#

794

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

795

# identifier) representing a Google group that has been recently

796

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

797

# the group is recovered, this value reverts to `group:{emailid}` and the

798

# recovered group retains the role in the binding.

799

#

800

#

801

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

802

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

807

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

808

},

809

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

810

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

811

# prevent simultaneous updates of a policy from overwriting each other.

812

# It is strongly suggested that systems make use of the `etag` in the

813

# read-modify-write cycle to perform policy updates in order to avoid race

814

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

815

# systems are expected to put that etag in the request to `setIamPolicy` to

816

# ensure that their change will be applied to the same version of the policy.

817

#

818

# **Important:** If you use IAM Conditions, you must include the `etag` field

819

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

820

# you to overwrite a version `3` policy with a version `1` policy, and all of

821

# the conditions in the version `3` policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

826

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

827

<pre>Lists Instances in a given project and location.

828

829

Args:

830

parent: string, Required. The resource name of the instance location using the form:

831

`projects/{project_id}/locations/{location_id}`

832

where `location_id` refers to a GCP region (required)

Bu Sun Kim

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

[diff] [blame^]

833

filter: string, List filter. For example, exclude all Memcached instances with name as

834

my-instance by specifying "name != my-instance".

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

835

pageToken: string, The next_page_token value returned from a previous List request,

836

if any.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

837

pageSize: integer, The maximum number of items to return.

838

839

If not specified, a default value of 1000 will be used by the service.

840

Regardless of the page_size value, the response may include a partial list

841

and a caller should only rely on response's

842

next_page_token

843

to determine if there are more instances left to be queried.

Bu Sun Kim

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

[diff] [blame^]

844

orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

845

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

852

853

{ # Response for ListInstances.

854

"resources": [ # A list of Memcached instances in the project in the specified location,

855

# or across all locations.

856

#

857

# If the `location_id` in the parent field of the request is "-", all regions

858

# available to the project are queried, and the results aggregated.

859

{

Bu Sun Kim

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

[diff] [blame^]

860

"parameters": { # Optional: User defined parameters to apply to the memcached process

861

# on each node.

862

"id": "A String", # Output only. The unique ID associated with this set of parameters. Users

863

# can use this id to determine if the parameters associated with the instance

864

# differ from the parameters associated with the nodes and any action needs

865

# to be taken to apply parameters on nodes.

866

"params": { # User defined set of parameters to use in the memcached process.

867

"a_key": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

868

},

869

},

Bu Sun Kim

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

[diff] [blame^]

870

"zones": [ # Zones where Memcached nodes should be provisioned in.

871

# Memcached nodes will be equally distributed across these zones. If not

872

# provided, the service will by default create nodes in all zones in the

873

# region for the instance.

874

"A String",

875

],

876

"nodeCount": 42, # Required. Number of nodes in the Memcached instance.

877

"instanceMessages": [ # List of messages that describe current statuses of memcached instance.

878

{

879

"message": "A String", # Message on memcached instance which will be exposed to users.

880

"code": "A String", # A code that correspond to one type of user-facing message.

881

},

882

],

883

"discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API

884

"createTime": "A String", # Output only. The time the instance was created.

885

"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance.

886

# System automatically determines the full memcached version for an instance

887

# based on the input MemcacheVersion.

888

# The full version format will be "memcached-1.5.16".

889

"labels": { # Resource labels to represent user-provided metadata.

890

# Refer to cloud documentation on labels for more details.

891

# https://cloud.google.com/compute/docs/labeling-resources

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

892

"a_key": "A String",

893

},

Bu Sun Kim

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

[diff] [blame^]

894

"displayName": "A String", # User provided name for the instance only used for display

895

# purposes. Cannot be more than 80 characters.

896

"memcacheNodes": [ # Output only. List of Memcached nodes.

897

# Refer to [Node] message for more details.

898

{

899

"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not

900

# include project or location like the Memcached instance name.

901

"parameters": { # User defined parameters currently applied to the node.

902

"id": "A String", # Output only. The unique ID associated with this set of parameters. Users

903

# can use this id to determine if the parameters associated with the instance

904

# differ from the parameters associated with the nodes and any action needs

905

# to be taken to apply parameters on nodes.

906

"params": { # User defined set of parameters to use in the memcached process.

"a_key": "A String",

},

},

"state": "A String", # Output only. Current state of the Memcached node.

911

"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.

912

"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the

913

# clients to connect to the Memcached server on this node.

914

"port": 42, # Output only. The port number of the Memcached server on this node.

915

},

916

],

917

"state": "A String", # Output only. The state of this Memcached instance.

918

"memcacheVersion": "A String", # The major version of Memcached software.

919

# If not provided, latest supported version will be used. Currently the

920

# latest supported major version is MEMCACHE_1_5.

921

# The minor version will be automatically determined by our system based on

922

# the latest supported minor version.

923

"name": "A String", # Required. Unique name of the resource in this scope including project and

924

# location using the form:

925

# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

926

#

927

# Note: Memcached instances are managed and addressed at regional level so

928

# location_id here refers to a GCP region; however, users may choose which

929

# zones Memcached nodes within an instances should be provisioned in.

930

# Refer to [zones] field for more details.

931

"updateTime": "A String", # Output only. The time the instance was updated.

932

"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.

933

"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.

934

"cpuCount": 42, # Required. Number of cpus per Memcached node.

935

},

936

"authorizedNetwork": "A String", # The full name of the Google Compute Engine

937

# [network](https://cloud.google.com/vpc/docs/vpc) to which the

938

# instance is connected. If left unspecified, the `default` network

939

# will be used.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

940

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

941

],

942

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

943

# results in the list.

944

"unreachable": [ # Locations that could not be reached.

"A String",

],

}</pre>

</div>

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

952

<pre>Retrieves the next page of results.

953

954

Args:

955

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

956

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

957

958

Returns:

959

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

960

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>

966

<pre>Updates an existing Instance in a given project and location.

967

968

Args:

969

name: string, Required. Unique name of the resource in this scope including project and

970

location using the form:

971

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

972

973

Note: Memcached instances are managed and addressed at regional level so

974

location_id here refers to a GCP region; however, users may choose which

975

zones Memcached nodes within an instances should be provisioned in.

976

Refer to [zones] field for more details. (required)

977

body: object, The request body.

978

The object takes the form of:

979

980

{

Bu Sun Kim

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

[diff] [blame^]

981

"parameters": { # Optional: User defined parameters to apply to the memcached process

982

# on each node.

983

"id": "A String", # Output only. The unique ID associated with this set of parameters. Users

984

# can use this id to determine if the parameters associated with the instance

985

# differ from the parameters associated with the nodes and any action needs

986

# to be taken to apply parameters on nodes.

987

"params": { # User defined set of parameters to use in the memcached process.

988

"a_key": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

989

},

990

},

Bu Sun Kim

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

[diff] [blame^]

991

"zones": [ # Zones where Memcached nodes should be provisioned in.

992

# Memcached nodes will be equally distributed across these zones. If not

993

# provided, the service will by default create nodes in all zones in the

994

# region for the instance.

995

"A String",

996

],

997

"nodeCount": 42, # Required. Number of nodes in the Memcached instance.

998

"instanceMessages": [ # List of messages that describe current statuses of memcached instance.

999

{

1000

"message": "A String", # Message on memcached instance which will be exposed to users.

1001

"code": "A String", # A code that correspond to one type of user-facing message.

1002

},

1003

],

1004

"discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API

1005

"createTime": "A String", # Output only. The time the instance was created.

1006

"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance.

1007

# System automatically determines the full memcached version for an instance

1008

# based on the input MemcacheVersion.

1009

# The full version format will be "memcached-1.5.16".

1010

"labels": { # Resource labels to represent user-provided metadata.

1011

# Refer to cloud documentation on labels for more details.

1012

# https://cloud.google.com/compute/docs/labeling-resources

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1013

"a_key": "A String",

1014

},

Bu Sun Kim

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

[diff] [blame^]

1015

"displayName": "A String", # User provided name for the instance only used for display

1016

# purposes. Cannot be more than 80 characters.

1017

"memcacheNodes": [ # Output only. List of Memcached nodes.

1018

# Refer to [Node] message for more details.

1019

{

1020

"nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not

1021

# include project or location like the Memcached instance name.

1022

"parameters": { # User defined parameters currently applied to the node.

1023

"id": "A String", # Output only. The unique ID associated with this set of parameters. Users

1024

# can use this id to determine if the parameters associated with the instance

1025

# differ from the parameters associated with the nodes and any action needs

1026

# to be taken to apply parameters on nodes.

1027

"params": { # User defined set of parameters to use in the memcached process.

"a_key": "A String",

},

},

"state": "A String", # Output only. Current state of the Memcached node.

1032

"zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.

1033

"host": "A String", # Output only. Hostname or IP address of the Memcached node used by the

1034

# clients to connect to the Memcached server on this node.

1035

"port": 42, # Output only. The port number of the Memcached server on this node.

1036

},

1037

],

1038

"state": "A String", # Output only. The state of this Memcached instance.

1039

"memcacheVersion": "A String", # The major version of Memcached software.

1040

# If not provided, latest supported version will be used. Currently the

1041

# latest supported major version is MEMCACHE_1_5.

1042

# The minor version will be automatically determined by our system based on

1043

# the latest supported minor version.

1044

"name": "A String", # Required. Unique name of the resource in this scope including project and

1045

# location using the form:

1046

# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

1047

#

1048

# Note: Memcached instances are managed and addressed at regional level so

1049

# location_id here refers to a GCP region; however, users may choose which

1050

# zones Memcached nodes within an instances should be provisioned in.

1051

# Refer to [zones] field for more details.

1052

"updateTime": "A String", # Output only. The time the instance was updated.

1053

"nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.

1054

"memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.

1055

"cpuCount": 42, # Required. Number of cpus per Memcached node.

1056

},

1057

"authorizedNetwork": "A String", # The full name of the Google Compute Engine

1058

# [network](https://cloud.google.com/vpc/docs/vpc) to which the

1059

# instance is connected. If left unspecified, the `default` network

1060

# will be used.

1061

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1062

1063

updateMask: string, Required. Mask of fields to update.

1064

* `displayName`

1065

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1072

1073

{ # This resource represents a long-running operation that is the result of a

1074

# network API call.

Bu Sun Kim

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

[diff] [blame^]

1075

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

1076

# different programming environments, including REST APIs and RPC APIs. It is

1077

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1078

# three pieces of data: error code, error message, and error details.

1079

#

1080

# You can find out more about this error model and how to work with it in the

1081

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1082

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

1083

"details": [ # A list of messages that carry the error details. There is a common set of

1084

# message types for APIs to use.

1085

{

1086

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

1087

},

1088

],

1089

"message": "A String", # A developer-facing error message, which should be in English. Any

1090

# user-facing error message should be localized and sent in the

1091

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1092

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1093

"response": { # The normal response of the operation in case of success. If the original

1094

# method returns no data on success, such as `Delete`, the response is

1095

# `google.protobuf.Empty`. If the original method is standard

1096

# `Get`/`Create`/`Update`, the response should be the resource. For other

1097

# methods, the response should have the type `XxxResponse`, where `Xxx`

1098

# is the original method name. For example, if the original method name

1099

# is `TakeSnapshot()`, the inferred response type is

1100

# `TakeSnapshotResponse`.

1101

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

1102

},

1103

"name": "A String", # The server-assigned name, which is only unique within the same service that

1104

# originally returns it. If you use the default HTTP mapping, the

1105

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

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

[diff] [blame^]

1106

"metadata": { # Service-specific metadata associated with the operation. It typically

1107

# contains progress information and common metadata such as create time.

1108

# Some services might not provide such metadata. Any method that returns a

1109

# long-running operation should document the metadata type, if any.

1110

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1111

},

Bu Sun Kim

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

[diff] [blame^]

1112

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1113

# If `true`, the operation is completed, and either `error` or `response` is

1114

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

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

1120

<pre>Sets the access control policy on the specified resource. Replaces any

1121

existing policy.

1122

1123

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

1124

1125

Args:

1126

resource: string, REQUIRED: The resource for which the policy is being specified.

1127

See the operation documentation for the appropriate value for this field. (required)

1128

body: object, The request body.

1129

The object takes the form of:

1130

1131

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1132

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of

1133

# the policy is limited to a few 10s of KB. An empty policy is a

1134

# valid policy but certain Cloud Platform services (such as Projects)

1135

# might reject them.

1136

# controls for Google Cloud resources.

1137

#

1138

#

1139

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1140

# `members` to a single `role`. Members can be user accounts, service accounts,

1141

# Google groups, and domains (such as G Suite). A `role` is a named list of

1142

# permissions; each `role` can be an IAM predefined role or a user-created

1143

# custom role.

1144

#

1145

# For some types of Google Cloud resources, a `binding` can also specify a

1146

# `condition`, which is a logical expression that allows access to a resource

1147

# only if the expression evaluates to `true`. A condition can add constraints

1148

# based on attributes of the request, the resource, or both. To learn which

1149

# resources support conditions in their IAM policies, see the

1150

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

1158

# "members": [

1159

# "user:mike@example.com",

1160

# "group:admins@example.com",

1161

# "domain:google.com",

1162

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

1167

# "members": [

1168

# "user:eve@example.com"

1169

# ],

1170

# "condition": {

1171

# "title": "expirable access",

1172

# "description": "Does not grant access after Sep 2020",

1173

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

1186

# - group:admins@example.com

1187

# - domain:google.com

1188

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1189

# role: roles/resourcemanager.organizationAdmin

1190

# - members:

1191

# - user:eve@example.com

1192

# role: roles/resourcemanager.organizationViewer

1193

# condition:

1194

# title: expirable access

1195

# description: Does not grant access after Sep 2020

1196

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

1197

# - etag: BwWWja0YfJA=

1198

# - version: 3

1199

#

1200

# For a description of IAM and its features, see the

1201

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame^]

1202

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

1203

{ # Specifies the audit configuration for a service.

1204

# The configuration determines which permission types are logged, and what

1205

# identities, if any, are exempted from logging.

1206

# An AuditConfig must have one or more AuditLogConfigs.

1207

#

1208

# If there are AuditConfigs for both `allServices` and a specific service,

1209

# the union of the two AuditConfigs is used for that service: the log_types

1210

# specified in each AuditConfig are enabled, and the exempted_members in each

1211

# AuditLogConfig are exempted.

1212

#

1213

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

1219

# "audit_log_configs": [

1220

# {

1221

# "log_type": "DATA_READ",

1222

# "exempted_members": [

1223

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

1228

# },

1229

# {

1230

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com",

1236

# "audit_log_configs": [

1237

# {

1238

# "log_type": "DATA_READ"

1239

# },

1240

# {

1241

# "log_type": "DATA_WRITE",

1242

# "exempted_members": [

1243

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1252

# logging. It also exempts jose@example.com from DATA_READ logging, and

1253

# aliya@example.com from DATA_WRITE logging.

1254

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

1255

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

1260

# {

1261

# "log_type": "DATA_READ",

1262

# "exempted_members": [

1263

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1273

# jose@example.com from DATA_READ logging.

1274

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

1275

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1276

# permission.

1277

# Follows the same format of Binding.members.

"A String",

],

},

],

"service": "A String", # Specifies a service that will be enabled for audit logging.

1283

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1284

# `allServices` is a special value that covers all services.

1285

},

1286

],

1287

"version": 42, # Specifies the format of the policy.

1288

#

1289

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1290

# are rejected.

1291

#

1292

# Any operation that affects conditional role bindings must specify version

1293

# `3`. This requirement applies to the following operations:

1294

#

1295

# * Getting a policy that includes a conditional role binding

1296

# * Adding a conditional role binding to a policy

1297

# * Changing a conditional role binding in a policy

1298

# * Removing any role binding, with or without a condition, from a policy

1299

# that includes conditions

1300

#

1301

# **Important:** If you use IAM Conditions, you must include the `etag` field

1302

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1303

# you to overwrite a version `3` policy with a version `1` policy, and all of

1304

# the conditions in the version `3` policy are lost.

1305

#

1306

# If a policy does not include any conditions, operations on that policy may

1307

# specify any valid version or leave the field unset.

1308

#

1309

# To learn which resources support conditions in their IAM policies, see the

1310

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1311

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

1312

# `condition` that determines how and when the `bindings` are applied. Each

1313

# of the `bindings` must contain at least one member.

1314

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

1315

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1316

#

1317

# If the condition evaluates to `true`, then this binding applies to the

1318

# current request.

1319

#

1320

# If the condition evaluates to `false`, then this binding does not apply to

1321

# the current request. However, a different role binding might grant the same

1322

# role to one or more of the members in this binding.

1323

#

1324

# To learn which resources support conditions in their IAM policies, see the

1325

# [IAM

1326

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1327

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1328

# are documented at https://github.com/google/cel-spec.

1329

#

1330

# Example (Comparison):

1331

#

1332

# title: "Summary size limit"

1333

# description: "Determines if a summary is less than 100 chars"

1334

# expression: "document.summary.size() < 100"

1335

#

1336

# Example (Equality):

1337

#

1338

# title: "Requestor is owner"

1339

# description: "Determines if requestor is the document owner"

1340

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1345

# description: "Determine whether the document should be publicly visible"

1346

# expression: "document.type != 'private' && document.type != 'internal'"

1347

#

1348

# Example (Data Manipulation):

1349

#

1350

# title: "Notification string"

1351

# description: "Create a notification string with a timestamp."

1352

# expression: "'New message received at ' + string(document.create_time)"

1353

#

1354

# The exact variables and functions that may be referenced within an expression

1355

# are determined by the service that evaluates it. See the service

1356

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame^]

1357

"description": "A String", # Optional. Description of the expression. This is a longer text which

1358

# describes the expression, e.g. when hovered over it in a UI.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1359

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

1360

# its purpose. This can be used e.g. in UIs which allow to enter the

1361

# expression.

Bu Sun Kim

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

[diff] [blame^]

1362

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

1363

# syntax.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1364

"location": "A String", # Optional. String indicating the location of the expression for error

1365

# reporting, e.g. a file name and a position in the file.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1366

},

1367

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

1368

# `members` can have the following values:

1369

#

1370

# * `allUsers`: A special identifier that represents anyone who is

1371

# on the internet; with or without a Google account.

1372

#

1373

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1374

# who is authenticated with a Google account or a service account.

1375

#

1376

# * `user:{emailid}`: An email address that represents a specific Google

1377

# account. For example, `alice@example.com` .

1378

#

1379

#

1380

# * `serviceAccount:{emailid}`: An email address that represents a service

1381

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1382

#

1383

# * `group:{emailid}`: An email address that represents a Google group.

1384

# For example, `admins@example.com`.

1385

#

1386

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1387

# identifier) representing a user that has been recently deleted. For

1388

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1389

# recovered, this value reverts to `user:{emailid}` and the recovered user

1390

# retains the role in the binding.

1391

#

1392

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1393

# unique identifier) representing a service account that has been recently

1394

# deleted. For example,

1395

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1396

# If the service account is undeleted, this value reverts to

1397

# `serviceAccount:{emailid}` and the undeleted service account retains the

1398

# role in the binding.

1399

#

1400

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1401

# identifier) representing a Google group that has been recently

1402

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1403

# the group is recovered, this value reverts to `group:{emailid}` and the

1404

# recovered group retains the role in the binding.

1405

#

1406

#

1407

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

1408

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

1413

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1414

},

1415

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1416

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1417

# prevent simultaneous updates of a policy from overwriting each other.

1418

# It is strongly suggested that systems make use of the `etag` in the

1419

# read-modify-write cycle to perform policy updates in order to avoid race

1420

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1421

# systems are expected to put that etag in the request to `setIamPolicy` to

1422

# ensure that their change will be applied to the same version of the policy.

1423

#

1424

# **Important:** If you use IAM Conditions, you must include the `etag` field

1425

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1426

# you to overwrite a version `3` policy with a version `1` policy, and all of

1427

# the conditions in the version `3` policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1428

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1429

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

1430

# the fields in the mask will be modified. If no mask is provided, the

1431

# following default mask is used:

1432

#

1433

# `paths: "bindings, etag"`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1434

}

1435

1436

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1443

1444

{ # An Identity and Access Management (IAM) policy, which specifies access

1445

# controls for Google Cloud resources.

1446

#

1447

#

1448

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1449

# `members` to a single `role`. Members can be user accounts, service accounts,

1450

# Google groups, and domains (such as G Suite). A `role` is a named list of

1451

# permissions; each `role` can be an IAM predefined role or a user-created

1452

# custom role.

1453

#

1454

# For some types of Google Cloud resources, a `binding` can also specify a

1455

# `condition`, which is a logical expression that allows access to a resource

1456

# only if the expression evaluates to `true`. A condition can add constraints

1457

# based on attributes of the request, the resource, or both. To learn which

1458

# resources support conditions in their IAM policies, see the

1459

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

1467

# "members": [

1468

# "user:mike@example.com",

1469

# "group:admins@example.com",

1470

# "domain:google.com",

1471

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

1476

# "members": [

1477

# "user:eve@example.com"

1478

# ],

1479

# "condition": {

1480

# "title": "expirable access",

1481

# "description": "Does not grant access after Sep 2020",

1482

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

1495

# - group:admins@example.com

1496

# - domain:google.com

1497

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1498

# role: roles/resourcemanager.organizationAdmin

1499

# - members:

1500

# - user:eve@example.com

1501

# role: roles/resourcemanager.organizationViewer

1502

# condition:

1503

# title: expirable access

1504

# description: Does not grant access after Sep 2020

1505

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

1506

# - etag: BwWWja0YfJA=

1507

# - version: 3

1508

#

1509

# For a description of IAM and its features, see the

1510

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame^]

1511

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

1512

{ # Specifies the audit configuration for a service.

1513

# The configuration determines which permission types are logged, and what

1514

# identities, if any, are exempted from logging.

1515

# An AuditConfig must have one or more AuditLogConfigs.

1516

#

1517

# If there are AuditConfigs for both `allServices` and a specific service,

1518

# the union of the two AuditConfigs is used for that service: the log_types

1519

# specified in each AuditConfig are enabled, and the exempted_members in each

1520

# AuditLogConfig are exempted.

1521

#

1522

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices",

1528

# "audit_log_configs": [

1529

# {

1530

# "log_type": "DATA_READ",

1531

# "exempted_members": [

1532

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

1537

# },

1538

# {

1539

# "log_type": "ADMIN_READ"

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com",

1545

# "audit_log_configs": [

1546

# {

1547

# "log_type": "DATA_READ"

1548

# },

1549

# {

1550

# "log_type": "DATA_WRITE",

1551

# "exempted_members": [

1552

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1561

# logging. It also exempts jose@example.com from DATA_READ logging, and

1562

# aliya@example.com from DATA_WRITE logging.

1563

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

1564

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

1569

# {

1570

# "log_type": "DATA_READ",

1571

# "exempted_members": [

1572

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE"

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1582

# jose@example.com from DATA_READ logging.

1583

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

1584

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1585

# permission.

1586

# Follows the same format of Binding.members.

"A String",

],

},

],

"service": "A String", # Specifies a service that will be enabled for audit logging.

1592

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1593

# `allServices` is a special value that covers all services.

1594

},

1595

],

1596

"version": 42, # Specifies the format of the policy.

1597

#

1598

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1599

# are rejected.

1600

#

1601

# Any operation that affects conditional role bindings must specify version

1602

# `3`. This requirement applies to the following operations:

1603

#

1604

# * Getting a policy that includes a conditional role binding

1605

# * Adding a conditional role binding to a policy

1606

# * Changing a conditional role binding in a policy

1607

# * Removing any role binding, with or without a condition, from a policy

1608

# that includes conditions

1609

#

1610

# **Important:** If you use IAM Conditions, you must include the `etag` field

1611

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1612

# you to overwrite a version `3` policy with a version `1` policy, and all of

1613

# the conditions in the version `3` policy are lost.

1614

#

1615

# If a policy does not include any conditions, operations on that policy may

1616

# specify any valid version or leave the field unset.

1617

#

1618

# To learn which resources support conditions in their IAM policies, see the

1619

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1620

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

1621

# `condition` that determines how and when the `bindings` are applied. Each

1622

# of the `bindings` must contain at least one member.

1623

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

1624

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1625

#

1626

# If the condition evaluates to `true`, then this binding applies to the

1627

# current request.

1628

#

1629

# If the condition evaluates to `false`, then this binding does not apply to

1630

# the current request. However, a different role binding might grant the same

1631

# role to one or more of the members in this binding.

1632

#

1633

# To learn which resources support conditions in their IAM policies, see the

1634

# [IAM

1635

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1636

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1637

# are documented at https://github.com/google/cel-spec.

1638

#

1639

# Example (Comparison):

1640

#

1641

# title: "Summary size limit"

1642

# description: "Determines if a summary is less than 100 chars"

1643

# expression: "document.summary.size() < 100"

1644

#

1645

# Example (Equality):

1646

#

1647

# title: "Requestor is owner"

1648

# description: "Determines if requestor is the document owner"

1649

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1654

# description: "Determine whether the document should be publicly visible"

1655

# expression: "document.type != 'private' && document.type != 'internal'"

1656

#

1657

# Example (Data Manipulation):

1658

#

1659

# title: "Notification string"

1660

# description: "Create a notification string with a timestamp."

1661

# expression: "'New message received at ' + string(document.create_time)"

1662

#

1663

# The exact variables and functions that may be referenced within an expression

1664

# are determined by the service that evaluates it. See the service

1665

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame^]

1666

"description": "A String", # Optional. Description of the expression. This is a longer text which

1667

# describes the expression, e.g. when hovered over it in a UI.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1668

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

1669

# its purpose. This can be used e.g. in UIs which allow to enter the

1670

# expression.

Bu Sun Kim

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

[diff] [blame^]

1671

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

1672

# syntax.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1673

"location": "A String", # Optional. String indicating the location of the expression for error

1674

# reporting, e.g. a file name and a position in the file.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1675

},

1676

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

1677

# `members` can have the following values:

1678

#

1679

# * `allUsers`: A special identifier that represents anyone who is

1680

# on the internet; with or without a Google account.

1681

#

1682

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1683

# who is authenticated with a Google account or a service account.

1684

#

1685

# * `user:{emailid}`: An email address that represents a specific Google

1686

# account. For example, `alice@example.com` .

1687

#

1688

#

1689

# * `serviceAccount:{emailid}`: An email address that represents a service

1690

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1691

#

1692

# * `group:{emailid}`: An email address that represents a Google group.

1693

# For example, `admins@example.com`.

1694

#

1695

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1696

# identifier) representing a user that has been recently deleted. For

1697

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1698

# recovered, this value reverts to `user:{emailid}` and the recovered user

1699

# retains the role in the binding.

1700

#

1701

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1702

# unique identifier) representing a service account that has been recently

1703

# deleted. For example,

1704

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1705

# If the service account is undeleted, this value reverts to

1706

# `serviceAccount:{emailid}` and the undeleted service account retains the

1707

# role in the binding.

1708

#

1709

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1710

# identifier) representing a Google group that has been recently

1711

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1712

# the group is recovered, this value reverts to `group:{emailid}` and the

1713

# recovered group retains the role in the binding.

1714

#

1715

#

1716

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

1717

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

1722

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1723

},

1724

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1725

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1726

# prevent simultaneous updates of a policy from overwriting each other.

1727

# It is strongly suggested that systems make use of the `etag` in the

1728

# read-modify-write cycle to perform policy updates in order to avoid race

1729

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1730

# systems are expected to put that etag in the request to `setIamPolicy` to

1731

# ensure that their change will be applied to the same version of the policy.

1732

#

1733

# **Important:** If you use IAM Conditions, you must include the `etag` field

1734

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1735

# you to overwrite a version `3` policy with a version `1` policy, and all of

1736

# the conditions in the version `3` policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

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

1742

<pre>Returns permissions that a caller has on the specified resource.

1743

If the resource does not exist, this will return an empty set of

1744

permissions, not a `NOT_FOUND` error.

1745

1746

Note: This operation is designed to be used for building permission-aware

1747

UIs and command-line tools, not for authorization checking. This operation

1748

may "fail open" without warning.

1749

1750

Args:

1751

resource: string, REQUIRED: The resource for which the policy detail is being requested.

1752

See the operation documentation for the appropriate value for this field. (required)

1753

body: object, The request body.

1754

The object takes the form of:

1755

1756

{ # Request message for `TestIamPermissions` method.

1757

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

1758

# wildcards (such as '*' or 'storage.*') are not allowed. For more

1759

# information see

1760

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1772

1773

{ # Response message for `TestIamPermissions` method.

1774

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

# allowed.

"A String",

],

}</pre>

</div>

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

1783

<pre>Updates the defined Memcached Parameters for an existing Instance.

1784

This method only stages the parameters, it must be followed by

1785

ApplyParameters to apply the parameters to nodes of the Memcached Instance.

1786

1787

Args:

1788

name: string, Required. Resource name of the Memcached instance for which the parameters should be

1789

updated. (required)

1790

body: object, The request body.

1791

The object takes the form of:

1792

1793

{ # Request for UpdateParameters.

1794

"updateMask": "A String", # Required. Mask of fields to update.

1795

"parameters": { # The parameters to apply to the instance.

1796

"id": "A String", # Output only. The unique ID associated with this set of parameters. Users

1797

# can use this id to determine if the parameters associated with the instance

1798

# differ from the parameters associated with the nodes and any action needs

1799

# to be taken to apply parameters on nodes.

1800

"params": { # User defined set of parameters to use in the memcached process.

"a_key": "A String",

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1813

1814

{ # This resource represents a long-running operation that is the result of a

1815

# network API call.

Bu Sun Kim

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

[diff] [blame^]

1816

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

1817

# different programming environments, including REST APIs and RPC APIs. It is

1818

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1819

# three pieces of data: error code, error message, and error details.

1820

#

1821

# You can find out more about this error model and how to work with it in the

1822

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1823

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

1824

"details": [ # A list of messages that carry the error details. There is a common set of

1825

# message types for APIs to use.

1826

{

1827

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

1828

},

1829

],

1830

"message": "A String", # A developer-facing error message, which should be in English. Any

1831

# user-facing error message should be localized and sent in the

1832

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1833

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1834

"response": { # The normal response of the operation in case of success. If the original

1835

# method returns no data on success, such as `Delete`, the response is

1836

# `google.protobuf.Empty`. If the original method is standard

1837

# `Get`/`Create`/`Update`, the response should be the resource. For other

1838

# methods, the response should have the type `XxxResponse`, where `Xxx`

1839

# is the original method name. For example, if the original method name

1840

# is `TakeSnapshot()`, the inferred response type is

1841

# `TakeSnapshotResponse`.

1842

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

1843

},

1844

"name": "A String", # The server-assigned name, which is only unique within the same service that

1845

# originally returns it. If you use the default HTTP mapping, the

1846

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

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

[diff] [blame^]

1847

"metadata": { # Service-specific metadata associated with the operation. It typically

1848

# contains progress information and common metadata such as create time.

1849

# Some services might not provide such metadata. Any method that returns a

1850

# long-running operation should document the metadata type, if any.

1851

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1852

},

Bu Sun Kim

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

[diff] [blame^]

1853

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1854

# If `true`, the operation is completed, and either `error` or `response` is

1855

# available.

Bu Sun Kim