Blame - docs/dyn/cloudresourcemanager_v1beta1.projects.html - platform/external/python/google-api-python-client

2015-06-15 16:44:50 +0000

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

78

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

79

<p class="firstline">Creates a Project resource.</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

80

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

81

<code><a href="#delete">delete(projectId, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

82

<p class="firstline">Marks the Project identified by the specified</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

83

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

84

<code><a href="#get">get(projectId, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

85

<p class="firstline">Retrieves the Project identified by the specified</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

86

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

87

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

88

<p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

89

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

90

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

91

<p class="firstline">Returns the IAM access control policy for the specified Project.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

92

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

93

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

94

<p class="firstline">Lists Projects that the caller has the `resourcemanager.projects.get`</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

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

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

99

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

100

<p class="firstline">Sets the IAM access control policy for the specified Project. Overwrites</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

101

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

102

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

Jon Wayne Parrott

36e41bc

2016-02-19 16:02:29 -0800

[diff] [blame]

103

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

104

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

105

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

106

<p class="firstline">Restores the Project identified by the specified</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

107

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

108

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

109

<p class="firstline">Updates the attributes of the Project identified by the specified</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

110

<h3>Method Details</h3>

111

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

112

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

113

<pre>Creates a Project resource.

114

115

Initially, the Project resource is owned by its creator exclusively.

116

The creator can later grant permission to others to read or update the

117

Project.

118

119

Several APIs are activated automatically for the Project, including

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

120

Google Cloud Storage. The parent is identified by a specified

121

ResourceId, which must include both an ID and a type, such as

122

project, folder, or organization.

123

124

This method does not associate the new project with a billing account.

125

You can set or update the billing account associated with a project using

126

the [`projects.updateBillingInfo`]

127

(/billing/reference/rest/v1/projects/updateBillingInfo) method.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

128

129

Args:

130

body: object, The request body. (required)

131

The object takes the form of:

132

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

133

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

134

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

135

# Google Cloud Platform resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

136

"name": "A String", # The optional user-assigned display name of the Project.

137

# When present it must be between 4 to 30 characters.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

138

# Allowed characters are: lowercase and uppercase letters, numbers,

139

# hyphen, single-quote, double-quote, space, and exclamation point.

140

#

141

# Example: <code>My Project</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

142

# Read-write.

143

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

144

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

145

# Supported parent types include "organization" and "folder". Once set, the

146

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

147

# `UpdateProject` method; the end user must have the

148

# `resourcemanager.projects.create` permission on the parent.

149

#

150

# Read-write.

151

# Cloud Platform is a generic term for something you (a developer) may want to

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

152

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

153

# a Compute Engine instance, a Cloud SQL database, and so on.

154

"type": "A String", # Required field representing the resource type this id is for.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

155

# At present, the valid types are "project", "folder", and "organization".

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

156

"id": "A String", # Required field for the type-specific id. This should correspond to the id

157

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

158

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

159

"projectId": "A String", # The unique, user-assigned ID of the Project.

160

# It must be 6 to 30 lowercase letters, digits, or hyphens.

161

# It must start with a letter.

162

# Trailing hyphens are prohibited.

163

#

164

# Example: <code>tokyo-rain-123</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

165

# Read-only after creation.

166

"labels": { # The labels associated with this Project.

167

#

168

# Label keys must be between 1 and 63 characters long and must conform

169

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

170

#

171

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

172

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

173

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

174

#

175

# No more than 256 labels can be associated with a given resource.

176

#

177

# Clients should store labels in a representation such as JSON that does not

178

# depend on specific characters being disallowed.

179

#

180

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

181

# Read-write.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

182

"a_key": "A String",

183

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

184

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

185

#

186

# Read-only.

187

"lifecycleState": "A String", # The Project lifecycle state.

188

#

189

# Read-only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

190

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

191

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

192

# Example: <code>415104041262</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

193

# Read-only.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

194

}

195

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

196

useLegacyStack: boolean, A safety hatch to opt out of the new reliable project creation process.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

197

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

198

Allowed values

199

1 - v1 error format

200

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

201

202

Returns:

203

An object of the form:

204

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

205

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

206

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

207

# Google Cloud Platform resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

208

"name": "A String", # The optional user-assigned display name of the Project.

209

# When present it must be between 4 to 30 characters.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

210

# Allowed characters are: lowercase and uppercase letters, numbers,

211

# hyphen, single-quote, double-quote, space, and exclamation point.

212

#

213

# Example: <code>My Project</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

214

# Read-write.

215

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

216

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

217

# Supported parent types include "organization" and "folder". Once set, the

218

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

219

# `UpdateProject` method; the end user must have the

220

# `resourcemanager.projects.create` permission on the parent.

221

#

222

# Read-write.

223

# Cloud Platform is a generic term for something you (a developer) may want to

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

224

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

225

# a Compute Engine instance, a Cloud SQL database, and so on.

226

"type": "A String", # Required field representing the resource type this id is for.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

227

# At present, the valid types are "project", "folder", and "organization".

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

228

"id": "A String", # Required field for the type-specific id. This should correspond to the id

229

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

230

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

231

"projectId": "A String", # The unique, user-assigned ID of the Project.

232

# It must be 6 to 30 lowercase letters, digits, or hyphens.

233

# It must start with a letter.

234

# Trailing hyphens are prohibited.

235

#

236

# Example: <code>tokyo-rain-123</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

237

# Read-only after creation.

238

"labels": { # The labels associated with this Project.

239

#

240

# Label keys must be between 1 and 63 characters long and must conform

241

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

242

#

243

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

244

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

245

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

246

#

247

# No more than 256 labels can be associated with a given resource.

248

#

249

# Clients should store labels in a representation such as JSON that does not

250

# depend on specific characters being disallowed.

251

#

252

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

253

# Read-write.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

254

"a_key": "A String",

255

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

256

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

257

#

258

# Read-only.

259

"lifecycleState": "A String", # The Project lifecycle state.

260

#

261

# Read-only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

262

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

263

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

264

# Example: <code>415104041262</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

265

# Read-only.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

270

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

271

<pre>Marks the Project identified by the specified

272

`project_id` (for example, `my-project-123`) for deletion.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

273

This method will only affect the Project if it has a lifecycle state of

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

274

ACTIVE.

275

276

This method changes the Project's lifecycle state from

277

ACTIVE

278

to DELETE_REQUESTED.

279

The deletion starts at an unspecified time, at which point the project is

280

no longer accessible.

281

282

Until the deletion completes, you can check the lifecycle state

283

checked by retrieving the Project with GetProject,

284

and the Project remains visible to ListProjects.

285

However, you cannot update the project.

286

287

After the deletion completes, the Project is not retrievable by

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

288

the GetProject

289

and ListProjects

290

methods.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

291

292

The caller must have modify permissions for this Project.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

293

294

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

295

projectId: string, The Project ID (for example, `foo-bar-123`).

296

297

Required. (required)

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

298

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

299

Allowed values

300

1 - v1 error format

301

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

302

303

Returns:

304

An object of the form:

305

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

306

{ # A generic empty message that you can re-use to avoid defining duplicated

307

# empty messages in your APIs. A typical example is to use it as the request

308

# or the response type of an API method. For instance:

309

#

310

# service Foo {

311

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

312

# }

313

#

314

# The JSON representation for `Empty` is empty JSON object `{}`.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

319

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

320

<pre>Retrieves the Project identified by the specified

321

`project_id` (for example, `my-project-123`).

322

323

The caller must have read permissions for this Project.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

324

325

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

326

projectId: string, The Project ID (for example, `my-project-123`).

327

328

Required. (required)

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

329

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

330

Allowed values

331

1 - v1 error format

332

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

333

334

Returns:

335

An object of the form:

336

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

337

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

338

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

339

# Google Cloud Platform resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

340

"name": "A String", # The optional user-assigned display name of the Project.

341

# When present it must be between 4 to 30 characters.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

342

# Allowed characters are: lowercase and uppercase letters, numbers,

343

# hyphen, single-quote, double-quote, space, and exclamation point.

344

#

345

# Example: <code>My Project</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

346

# Read-write.

347

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

348

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

349

# Supported parent types include "organization" and "folder". Once set, the

350

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

351

# `UpdateProject` method; the end user must have the

352

# `resourcemanager.projects.create` permission on the parent.

353

#

354

# Read-write.

355

# Cloud Platform is a generic term for something you (a developer) may want to

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

356

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

357

# a Compute Engine instance, a Cloud SQL database, and so on.

358

"type": "A String", # Required field representing the resource type this id is for.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

359

# At present, the valid types are "project", "folder", and "organization".

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

360

"id": "A String", # Required field for the type-specific id. This should correspond to the id

361

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

362

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

363

"projectId": "A String", # The unique, user-assigned ID of the Project.

364

# It must be 6 to 30 lowercase letters, digits, or hyphens.

365

# It must start with a letter.

366

# Trailing hyphens are prohibited.

367

#

368

# Example: <code>tokyo-rain-123</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

369

# Read-only after creation.

370

"labels": { # The labels associated with this Project.

371

#

372

# Label keys must be between 1 and 63 characters long and must conform

373

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

374

#

375

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

376

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

377

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

378

#

379

# No more than 256 labels can be associated with a given resource.

380

#

381

# Clients should store labels in a representation such as JSON that does not

382

# depend on specific characters being disallowed.

383

#

384

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

385

# Read-write.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

386

"a_key": "A String",

387

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

388

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

389

#

390

# Read-only.

391

"lifecycleState": "A String", # The Project lifecycle state.

392

#

393

# Read-only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

394

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

395

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

396

# Example: <code>415104041262</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

397

# Read-only.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

402

<code class="details" id="getAncestry">getAncestry(projectId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

403

<pre>Gets a list of ancestors in the resource hierarchy for the Project

404

identified by the specified `project_id` (for example, `my-project-123`).

405

406

The caller must have read permissions for this Project.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

407

408

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

409

projectId: string, The Project ID (for example, `my-project-123`).

410

411

Required. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

412

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

413

The object takes the form of:

414

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

415

{ # The request sent to the

416

# GetAncestry

417

# method.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

418

}

419

420

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

421

Allowed values

422

1 - v1 error format

423

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

424

425

Returns:

426

An object of the form:

427

428

{ # Response from the GetAncestry method.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

429

"ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The

430

# first ancestor is the project itself, followed by the project's parent,

431

# etc.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

432

{ # Identifying information for a single ancestor of a project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

433

"resourceId": { # A container to reference an id for any resource type. A `resource` in Google # Resource id of the ancestor.

434

# Cloud Platform is a generic term for something you (a developer) may want to

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

435

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

436

# a Compute Engine instance, a Cloud SQL database, and so on.

437

"type": "A String", # Required field representing the resource type this id is for.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

438

# At present, the valid types are "project", "folder", and "organization".

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

439

"id": "A String", # Required field for the type-specific id. This should correspond to the id

440

# used in the type-specific API's.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

},

},

],

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

448

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

449

<pre>Returns the IAM access control policy for the specified Project.

450

Permission is denied if the policy or the resource does not exist.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

451

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

452

For additional information about resource structure and identification,

453

see [Resource Names](/apis/design/resource_names).

454

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

455

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

456

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

457

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

458

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

459

The object takes the form of:

460

461

{ # Request message for `GetIamPolicy` method.

462

}

463

464

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

465

Allowed values

466

1 - v1 error format

467

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

468

469

Returns:

470

An object of the form:

471

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

472

{ # Defines an Identity and Access Management (IAM) policy. It is used to

473

# specify access control policies for Cloud Platform resources.

474

#

475

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

476

# A `Policy` consists of a list of `bindings`. A `binding` binds a list of

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

477

# `members` to a `role`, where the members can be user accounts, Google groups,

478

# Google domains, and service accounts. A `role` is a named list of permissions

479

# defined by IAM.

480

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

481

# **JSON Example**

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

#

# {

# "bindings": [

# {

# "role": "roles/owner",

487

# "members": [

488

# "user:mike@example.com",

489

# "group:admins@example.com",

490

# "domain:google.com",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

491

# "serviceAccount:my-other-app@appspot.gserviceaccount.com"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

# ]

# },

# {

# "role": "roles/viewer",

496

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

# **YAML Example**

#

# bindings:

# - members:

# - user:mike@example.com

506

# - group:admins@example.com

507

# - domain:google.com

508

# - serviceAccount:my-other-app@appspot.gserviceaccount.com

509

# role: roles/owner

510

# - members:

511

# - user:sean@example.com

512

# role: roles/viewer

513

#

514

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

515

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

516

# [IAM developer's guide](https://cloud.google.com/iam/docs).

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

517

"bindings": [ # Associates a list of `members` to a `role`.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

518

# `bindings` with no members will result in an error.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

519

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

520

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

521

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

522

"condition": { # Represents an expression text. Example: # The condition that is associated with this binding.

523

# NOTE: An unsatisfied condition will not allow user access via current

524

# binding. Different bindings, including their conditions, are examined

525

# independently.

526

#

527

# title: "User account presence"

528

# description: "Determines whether the request has a user account"

529

# expression: "size(request.user) > 0"

530

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

531

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

532

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

533

# Common Expression Language syntax.

534

#

535

# The application context of the containing message determines which

536

# well-known feature set of CEL is supported.

537

"location": "A String", # An optional string indicating the location of the expression for error

538

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

539

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

540

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

541

# expression.

542

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

543

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

544

# `members` can have the following values:

545

#

546

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

547

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

548

#

549

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

550

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

551

#

552

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

553

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

554

#

555

#

556

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

557

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

558

#

559

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

560

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

561

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

562

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

563

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

564

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

565

#

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

"A String",

],

},

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

570

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

571

{ # Specifies the audit configuration for a service.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

572

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

573

# identities, if any, are exempted from logging.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

574

# An AuditConfig must have one or more AuditLogConfigs.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

575

#

576

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

577

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

578

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

579

# AuditLogConfig are exempted.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

580

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

581

# Example Policy with multiple AuditConfigs:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

582

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

583

# {

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

584

# "audit_configs": [

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

585

# {

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

586

# "service": "allServices"

587

# "audit_log_configs": [

588

# {

589

# "log_type": "DATA_READ",

590

# "exempted_members": [

591

# "user:foo@gmail.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

596

# },

597

# {

598

# "log_type": "ADMIN_READ",

599

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

600

# ]

601

# },

602

# {

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

603

# "service": "fooservice.googleapis.com"

604

# "audit_log_configs": [

605

# {

606

# "log_type": "DATA_READ",

607

# },

608

# {

609

# "log_type": "DATA_WRITE",

610

# "exempted_members": [

611

# "user:bar@gmail.com"

612

# ]

613

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

# ]

# }

# ]

# }

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

618

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

619

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

620

# logging. It also exempts foo@gmail.com from DATA_READ logging, and

621

# bar@gmail.com from DATA_WRITE logging.

622

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

623

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

# Example:

#

# {

# "audit_log_configs": [

628

# {

629

# "log_type": "DATA_READ",

630

# "exempted_members": [

631

# "user:foo@gmail.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

641

# foo@gmail.com from DATA_READ logging.

642

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

643

# permission.

644

# Follows the same format of Binding.members.

645

"A String",

646

],

647

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

648

},

649

],

650

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

651

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

652

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

653

},

654

],

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

#

663

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

664

# policy is overwritten blindly.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

665

"version": 42, # Deprecated.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

670

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

671

<pre>Lists Projects that the caller has the `resourcemanager.projects.get`

672

permission on and satisfy the specified filter.

673

674

This method returns Projects in an unspecified order.

675

This method is eventually consistent with project mutations; this means

676

that a newly created project may not appear in the results or recent

677

updates to an existing project may not be reflected in the results. To

678

retrieve the latest state of a project, use the

679

GetProject method.

680

681

NOTE: If the request filter contains a `parent.type` and `parent.id` and

682

the caller has the `resourcemanager.projects.list` permission on the

683

parent, the results will be drawn from an alternate index which provides

684

more consistent results. In future versions of this API, this List method

685

will be split into List and Search to properly capture the behavorial

686

difference.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

687

688

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

689

pageSize: integer, The maximum number of Projects to return in the response.

690

The server can return fewer Projects than requested.

691

If unspecified, server picks an appropriate default.

692

693

Optional.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

694

pageToken: string, A pagination token returned from a previous call to ListProjects

695

that indicates from where listing should continue.

696

697

Optional.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

698

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

699

Allowed values

700

1 - v1 error format

701

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

702

filter: string, An expression for filtering the results of the request. Filter rules are

703

case insensitive. The fields eligible for filtering are:

+ `name`

+ `id`

+ `labels.<key>` (where *key* is the name of a label)

+ `parent.type`

+ `parent.id`

Some examples of using labels as filters:

712

713

| Filter | Description |

714

|------------------|-----------------------------------------------------|

715

| name:how* | The project's name starts with "how". |

716

| name:Howl | The project's name is `Howl` or `howl`. |

717

| name:HOWL | Equivalent to above. |

718

| NAME:howl | Equivalent to above. |

719

| labels.color:* | The project has the label `color`. |

720

| labels.color:red | The project's label `color` has the value `red`. |

721

| labels.color:red labels.size:big |The project's label `color` has

722

the value `red` and its label `size` has the value `big`. |

723

724

If no filter is specified, the call will return projects for which the user

725

has the `resourcemanager.projects.get` permission.

726

727

NOTE: To perform a by-parent query (eg., what projects are directly in a

728

Folder), the caller must have the `resourcemanager.projects.list`

729

permission on the parent and the filter must contain both a `parent.type`

730

and a `parent.id` restriction

731

(example: "parent.type:folder parent.id:123"). In this case an alternate

732

search index is used which provides more consistent results.

733

734

Optional.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

735

736

Returns:

737

An object of the form:

738

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

739

{ # A page of the response received from the

# ListProjects

# method.

#

# A paginated response where more pages are available has

744

# `next_page_token` set. This token can be used in a subsequent request to

745

# retrieve the next request page.

746

"nextPageToken": "A String", # Pagination token.

747

#

748

# If the result set is too large to fit in a single response, this token

749

# is returned. It encodes the position of the current result cursor.

750

# Feeding this value into a new list request with the `page_token` parameter

751

# gives the next page of the results.

752

#

753

# When `next_page_token` is not filled in, there is no next page and

754

# the list returned is the last page in the result set.

755

#

756

# Pagination tokens have a limited lifetime.

757

"projects": [ # The list of Projects that matched the list filter. This list can

758

# be paginated.

759

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

760

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

761

# Google Cloud Platform resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

762

"name": "A String", # The optional user-assigned display name of the Project.

763

# When present it must be between 4 to 30 characters.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

764

# Allowed characters are: lowercase and uppercase letters, numbers,

765

# hyphen, single-quote, double-quote, space, and exclamation point.

766

#

767

# Example: <code>My Project</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

768

# Read-write.

769

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

770

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

771

# Supported parent types include "organization" and "folder". Once set, the

772

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

773

# `UpdateProject` method; the end user must have the

774

# `resourcemanager.projects.create` permission on the parent.

775

#

776

# Read-write.

777

# Cloud Platform is a generic term for something you (a developer) may want to

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

778

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

779

# a Compute Engine instance, a Cloud SQL database, and so on.

780

"type": "A String", # Required field representing the resource type this id is for.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

781

# At present, the valid types are "project", "folder", and "organization".

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

782

"id": "A String", # Required field for the type-specific id. This should correspond to the id

783

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

784

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

785

"projectId": "A String", # The unique, user-assigned ID of the Project.

786

# It must be 6 to 30 lowercase letters, digits, or hyphens.

787

# It must start with a letter.

788

# Trailing hyphens are prohibited.

789

#

790

# Example: <code>tokyo-rain-123</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

791

# Read-only after creation.

792

"labels": { # The labels associated with this Project.

793

#

794

# Label keys must be between 1 and 63 characters long and must conform

795

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

796

#

797

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

798

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

799

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

800

#

801

# No more than 256 labels can be associated with a given resource.

802

#

803

# Clients should store labels in a representation such as JSON that does not

804

# depend on specific characters being disallowed.

805

#

806

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

807

# Read-write.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

808

"a_key": "A String",

809

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

810

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

811

#

812

# Read-only.

813

"lifecycleState": "A String", # The Project lifecycle state.

814

#

815

# Read-only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

816

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

817

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

818

# Example: <code>415104041262</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

819

# Read-only.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

},

],

}</pre>

</div>

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

827

<pre>Retrieves the next page of results.

828

829

Args:

830

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

831

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

832

833

Returns:

834

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

835

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

</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

840

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

841

<pre>Sets the IAM access control policy for the specified Project. Overwrites

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

842

any existing policy.

843

844

The following constraints apply when using `setIamPolicy()`:

845

846

+ Project does not support `allUsers` and `allAuthenticatedUsers` as

847

`members` in a `Binding` of a `Policy`.

848

849

+ The owner role can be granted only to `user` and `serviceAccount`.

850

851

+ Service accounts can be made owners of a project directly

852

without any restrictions. However, to be added as an owner, a user must be

853

invited via Cloud Platform console and must accept the invitation.

854

855

+ A user cannot be granted the owner role using `setIamPolicy()`. The user

856

must be granted the owner role using the Cloud Platform Console and must

857

explicitly accept the invitation.

858

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

859

+ Invitations to grant the owner role cannot be sent using

860

`setIamPolicy()`; they must be sent only using the Cloud Platform Console.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

861

862

+ Membership changes that leave the project without any owners that have

863

accepted the Terms of Service (ToS) will be rejected.

864

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

865

+ If the project is not part of an organization, there must be at least

866

one owner who has accepted the Terms of Service (ToS) agreement in the

867

policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner

868

from the policy will fail. This restriction also applies to legacy

869

projects that no longer have owners who have accepted the ToS. Edits to

870

IAM policies will be rejected until the lack of a ToS-accepting owner is

871

rectified.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

872

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

873

+ This method will replace the existing policy, and cannot be used to

874

append additional IAM settings.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

875

876

Note: Removing service accounts from policies or changing their roles

877

can render services completely inoperable. It is important to understand

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

878

how the service account is being used before removing or updating its

879

roles.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

880

881

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

882

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

883

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

884

body: object, The request body. (required)

885

The object takes the form of:

886

887

{ # Request message for `SetIamPolicy` method.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

888

"policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of

889

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

890

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

891

# might reject them.

892

# specify access control policies for Cloud Platform resources.

893

#

894

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

895

# A `Policy` consists of a list of `bindings`. A `binding` binds a list of

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

896

# `members` to a `role`, where the members can be user accounts, Google groups,

897

# Google domains, and service accounts. A `role` is a named list of permissions

898

# defined by IAM.

899

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

900

# **JSON Example**

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

#

# {

# "bindings": [

# {

# "role": "roles/owner",

906

# "members": [

907

# "user:mike@example.com",

908

# "group:admins@example.com",

909

# "domain:google.com",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

910

# "serviceAccount:my-other-app@appspot.gserviceaccount.com"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

# ]

# },

# {

# "role": "roles/viewer",

915

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

# **YAML Example**

#

# bindings:

# - members:

# - user:mike@example.com

925

# - group:admins@example.com

926

# - domain:google.com

927

# - serviceAccount:my-other-app@appspot.gserviceaccount.com

928

# role: roles/owner

929

# - members:

930

# - user:sean@example.com

931

# role: roles/viewer

932

#

933

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

934

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

935

# [IAM developer's guide](https://cloud.google.com/iam/docs).

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

936

"bindings": [ # Associates a list of `members` to a `role`.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

937

# `bindings` with no members will result in an error.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

938

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

939

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

940

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

941

"condition": { # Represents an expression text. Example: # The condition that is associated with this binding.

942

# NOTE: An unsatisfied condition will not allow user access via current

943

# binding. Different bindings, including their conditions, are examined

944

# independently.

945

#

946

# title: "User account presence"

947

# description: "Determines whether the request has a user account"

948

# expression: "size(request.user) > 0"

949

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

950

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

951

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

952

# Common Expression Language syntax.

953

#

954

# The application context of the containing message determines which

955

# well-known feature set of CEL is supported.

956

"location": "A String", # An optional string indicating the location of the expression for error

957

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

958

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

959

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

960

# expression.

961

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

962

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

963

# `members` can have the following values:

964

#

965

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

966

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

967

#

968

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

969

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

970

#

971

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

972

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

973

#

974

#

975

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

976

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

977

#

978

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

979

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

980

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

981

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

982

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

983

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

984

#

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

"A String",

],

},

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

989

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

990

{ # Specifies the audit configuration for a service.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

991

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

992

# identities, if any, are exempted from logging.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

993

# An AuditConfig must have one or more AuditLogConfigs.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

994

#

995

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

996

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

997

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

998

# AuditLogConfig are exempted.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

999

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1000

# Example Policy with multiple AuditConfigs:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1001

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1002

# {

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1003

# "audit_configs": [

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1004

# {

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1005

# "service": "allServices"

1006

# "audit_log_configs": [

1007

# {

1008

# "log_type": "DATA_READ",

1009

# "exempted_members": [

1010

# "user:foo@gmail.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1015

# },

1016

# {

1017

# "log_type": "ADMIN_READ",

1018

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1019

# ]

1020

# },

1021

# {

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1022

# "service": "fooservice.googleapis.com"

1023

# "audit_log_configs": [

1024

# {

1025

# "log_type": "DATA_READ",

1026

# },

1027

# {

1028

# "log_type": "DATA_WRITE",

1029

# "exempted_members": [

1030

# "user:bar@gmail.com"

1031

# ]

1032

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

# ]

# }

# ]

# }

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1037

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1038

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

1039

# logging. It also exempts foo@gmail.com from DATA_READ logging, and

1040

# bar@gmail.com from DATA_WRITE logging.

1041

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1042

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

# Example:

#

# {

# "audit_log_configs": [

1047

# {

1048

# "log_type": "DATA_READ",

1049

# "exempted_members": [

1050

# "user:foo@gmail.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

1060

# foo@gmail.com from DATA_READ logging.

1061

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

1062

# permission.

1063

# Follows the same format of Binding.members.

1064

"A String",

1065

],

1066

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

1067

},

1068

],

1069

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1070

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1071

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

1072

},

1073

],

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

#

1082

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

1083

# policy is overwritten blindly.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1084

"version": 42, # Deprecated.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1085

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1086

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1087

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

1088

# following default mask is used:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1089

# paths: "bindings, etag"

1090

# This field is only used by Cloud IAM.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1091

}

1092

1093

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1094

Allowed values

1095

1 - v1 error format

1096

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1097

1098

Returns:

1099

An object of the form:

1100

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1101

{ # Defines an Identity and Access Management (IAM) policy. It is used to

1102

# specify access control policies for Cloud Platform resources.

1103

#

1104

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1105

# A `Policy` consists of a list of `bindings`. A `binding` binds a list of

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1106

# `members` to a `role`, where the members can be user accounts, Google groups,

1107

# Google domains, and service accounts. A `role` is a named list of permissions

1108

# defined by IAM.

1109

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1110

# **JSON Example**

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

#

# {

# "bindings": [

# {

# "role": "roles/owner",

1116

# "members": [

1117

# "user:mike@example.com",

1118

# "group:admins@example.com",

1119

# "domain:google.com",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1120

# "serviceAccount:my-other-app@appspot.gserviceaccount.com"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

# ]

# },

# {

# "role": "roles/viewer",

1125

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

# **YAML Example**

#

# bindings:

# - members:

# - user:mike@example.com

1135

# - group:admins@example.com

1136

# - domain:google.com

1137

# - serviceAccount:my-other-app@appspot.gserviceaccount.com

1138

# role: roles/owner

1139

# - members:

1140

# - user:sean@example.com

1141

# role: roles/viewer

1142

#

1143

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1144

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1145

# [IAM developer's guide](https://cloud.google.com/iam/docs).

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1146

"bindings": [ # Associates a list of `members` to a `role`.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1147

# `bindings` with no members will result in an error.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1148

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1149

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

1150

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1151

"condition": { # Represents an expression text. Example: # The condition that is associated with this binding.

1152

# NOTE: An unsatisfied condition will not allow user access via current

1153

# binding. Different bindings, including their conditions, are examined

1154

# independently.

1155

#

1156

# title: "User account presence"

1157

# description: "Determines whether the request has a user account"

1158

# expression: "size(request.user) > 0"

1159

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

1160

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

1161

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

1162

# Common Expression Language syntax.

1163

#

1164

# The application context of the containing message determines which

1165

# well-known feature set of CEL is supported.

1166

"location": "A String", # An optional string indicating the location of the expression for error

1167

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

1168

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

1169

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

1170

# expression.

1171

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1172

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

1173

# `members` can have the following values:

1174

#

1175

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

1176

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

1177

#

1178

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

1179

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

1180

#

1181

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1182

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1183

#

1184

#

1185

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

1186

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

1187

#

1188

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

1189

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

1190

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1191

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1192

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1193

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

1194

#

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

"A String",

],

},

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1199

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

1200

{ # Specifies the audit configuration for a service.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1201

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

1202

# identities, if any, are exempted from logging.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1203

# An AuditConfig must have one or more AuditLogConfigs.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1204

#

1205

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

1206

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

1207

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1208

# AuditLogConfig are exempted.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1209

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1210

# Example Policy with multiple AuditConfigs:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1211

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1212

# {

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1213

# "audit_configs": [

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1214

# {

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1215

# "service": "allServices"

1216

# "audit_log_configs": [

1217

# {

1218

# "log_type": "DATA_READ",

1219

# "exempted_members": [

1220

# "user:foo@gmail.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1225

# },

1226

# {

1227

# "log_type": "ADMIN_READ",

1228

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1229

# ]

1230

# },

1231

# {

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1232

# "service": "fooservice.googleapis.com"

1233

# "audit_log_configs": [

1234

# {

1235

# "log_type": "DATA_READ",

1236

# },

1237

# {

1238

# "log_type": "DATA_WRITE",

1239

# "exempted_members": [

1240

# "user:bar@gmail.com"

1241

# ]

1242

# }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

# ]

# }

# ]

# }

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1247

#

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1248

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

1249

# logging. It also exempts foo@gmail.com from DATA_READ logging, and

1250

# bar@gmail.com from DATA_WRITE logging.

1251

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1252

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

# Example:

#

# {

# "audit_log_configs": [

1257

# {

1258

# "log_type": "DATA_READ",

1259

# "exempted_members": [

1260

# "user:foo@gmail.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

1270

# foo@gmail.com from DATA_READ logging.

1271

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

1272

# permission.

1273

# Follows the same format of Binding.members.

1274

"A String",

1275

],

1276

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

1277

},

1278

],

1279

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1280

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1281

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

1282

},

1283

],

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1284

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

1285

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

1286

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

1287

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

1288

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

1289

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

1290

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

1291

#

1292

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

1293

# policy is overwritten blindly.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1294

"version": 42, # Deprecated.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

1299

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

Jon Wayne Parrott

36e41bc

2016-02-19 16:02:29 -0800

[diff] [blame]

1300

<pre>Returns permissions that a caller has on the specified Project.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1301

1302

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1303

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1304

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1305

body: object, The request body. (required)

1306

The object takes the form of:

1307

1308

{ # Request message for `TestIamPermissions` method.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1309

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

1310

# wildcards (such as '*' or 'storage.*') are not allowed. For more

1311

# information see

1312

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

"A String",

],

}

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1318

Allowed values

1319

1 - v1 error format

1320

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1321

1322

Returns:

1323

An object of the form:

1324

1325

{ # Response message for `TestIamPermissions` method.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1326

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

1327

# allowed.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

"A String",

],

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1334

<code class="details" id="undelete">undelete(projectId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1335

<pre>Restores the Project identified by the specified

1336

`project_id` (for example, `my-project-123`).

1337

You can only use this method for a Project that has a lifecycle state of

1338

DELETE_REQUESTED.

1339

After deletion starts, the Project cannot be restored.

1340

1341

The caller must have modify permissions for this Project.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1342

1343

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1344

projectId: string, The project ID (for example, `foo-bar-123`).

1345

1346

Required. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1347

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1348

The object takes the form of:

1349

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1350

{ # The request sent to the UndeleteProject

1351

# method.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1352

}

1353

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1354

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1355

Allowed values

1356

1 - v1 error format

1357

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1358

1359

Returns:

1360

An object of the form:

1361

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1362

{ # A generic empty message that you can re-use to avoid defining duplicated

1363

# empty messages in your APIs. A typical example is to use it as the request

1364

# or the response type of an API method. For instance:

1365

#

1366

# service Foo {

1367

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1368

# }

1369

#

1370

# The JSON representation for `Empty` is empty JSON object `{}`.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

1375

<code class="details" id="update">update(projectId, body, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1376

<pre>Updates the attributes of the Project identified by the specified

1377

`project_id` (for example, `my-project-123`).

1378

1379

The caller must have modify permissions for this Project.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1380

1381

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1382

projectId: string, The project ID (for example, `my-project-123`).

1383

1384

Required. (required)

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1385

body: object, The request body. (required)

1386

The object takes the form of:

1387

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1388

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1389

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1390

# Google Cloud Platform resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1391

"name": "A String", # The optional user-assigned display name of the Project.

1392

# When present it must be between 4 to 30 characters.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1393

# Allowed characters are: lowercase and uppercase letters, numbers,

1394

# hyphen, single-quote, double-quote, space, and exclamation point.

1395

#

1396

# Example: <code>My Project</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1397

# Read-write.

1398

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

1399

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1400

# Supported parent types include "organization" and "folder". Once set, the

1401

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1402

# `UpdateProject` method; the end user must have the

1403

# `resourcemanager.projects.create` permission on the parent.

1404

#

1405

# Read-write.

1406

# Cloud Platform is a generic term for something you (a developer) may want to

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1407

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1408

# a Compute Engine instance, a Cloud SQL database, and so on.

1409

"type": "A String", # Required field representing the resource type this id is for.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1410

# At present, the valid types are "project", "folder", and "organization".

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1411

"id": "A String", # Required field for the type-specific id. This should correspond to the id

1412

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1413

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1414

"projectId": "A String", # The unique, user-assigned ID of the Project.

1415

# It must be 6 to 30 lowercase letters, digits, or hyphens.

1416

# It must start with a letter.

1417

# Trailing hyphens are prohibited.

1418

#

1419

# Example: <code>tokyo-rain-123</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1420

# Read-only after creation.

1421

"labels": { # The labels associated with this Project.

1422

#

1423

# Label keys must be between 1 and 63 characters long and must conform

1424

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

1425

#

1426

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1427

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

1428

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1429

#

1430

# No more than 256 labels can be associated with a given resource.

1431

#

1432

# Clients should store labels in a representation such as JSON that does not

1433

# depend on specific characters being disallowed.

1434

#

1435

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1436

# Read-write.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1437

"a_key": "A String",

1438

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1439

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1440

#

1441

# Read-only.

1442

"lifecycleState": "A String", # The Project lifecycle state.

1443

#

1444

# Read-only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1445

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1446

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1447

# Example: <code>415104041262</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1448

# Read-only.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1449

}

1450

1451

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1452

Allowed values

1453

1 - v1 error format

1454

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1455

1456

Returns:

1457

An object of the form:

1458

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1459

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1460

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1461

# Google Cloud Platform resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1462

"name": "A String", # The optional user-assigned display name of the Project.

1463

# When present it must be between 4 to 30 characters.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1464

# Allowed characters are: lowercase and uppercase letters, numbers,

1465

# hyphen, single-quote, double-quote, space, and exclamation point.

1466

#

1467

# Example: <code>My Project</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1468

# Read-write.

1469

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

1470

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1471

# Supported parent types include "organization" and "folder". Once set, the

1472

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1473

# `UpdateProject` method; the end user must have the

1474

# `resourcemanager.projects.create` permission on the parent.

1475

#

1476

# Read-write.

1477

# Cloud Platform is a generic term for something you (a developer) may want to

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1478

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1479

# a Compute Engine instance, a Cloud SQL database, and so on.

1480

"type": "A String", # Required field representing the resource type this id is for.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1481

# At present, the valid types are "project", "folder", and "organization".

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1482

"id": "A String", # Required field for the type-specific id. This should correspond to the id

1483

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1484

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1485

"projectId": "A String", # The unique, user-assigned ID of the Project.

1486

# It must be 6 to 30 lowercase letters, digits, or hyphens.

1487

# It must start with a letter.

1488

# Trailing hyphens are prohibited.

1489

#

1490

# Example: <code>tokyo-rain-123</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1491

# Read-only after creation.

1492

"labels": { # The labels associated with this Project.

1493

#

1494

# Label keys must be between 1 and 63 characters long and must conform

1495

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

1496

#

1497

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1498

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

1499

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1500

#

1501

# No more than 256 labels can be associated with a given resource.

1502

#

1503

# Clients should store labels in a representation such as JSON that does not

1504

# depend on specific characters being disallowed.

1505

#

1506

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1507

# Read-write.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1508

"a_key": "A String",

1509

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1510

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1511

#

1512

# Read-only.

1513

"lifecycleState": "A String", # The Project lifecycle state.

1514

#

1515

# Read-only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1516

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1517

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame^]

1518

# Example: <code>415104041262</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1519

# Read-only.

Nathaniel Manista