Blame - docs/dyn/storage_v1.defaultObjectAccessControls.html - platform/external/python/google-api-python-client

2014-08-14 00:47:23 -0700

[diff] [blame]

91

<p class="firstline">Retrieves default object ACL entries on the specified bucket.</p>

92

Bu Sun Kim

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

[diff] [blame]

93

<code><a href="#patch">patch(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Patches a default object ACL entry on the specified bucket.</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

95

Bu Sun Kim

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

[diff] [blame]

96

<code><a href="#update">update(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

97

<p class="firstline">Updates a default object ACL entry on the specified bucket.</p>

98

<h3>Method Details</h3>

99

Dmitry Frenkel

3e17f89

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

[diff] [blame]

100

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

101

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

105

<code class="details" id="delete">delete(bucket, entity, provisionalUserProject=None, userProject=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

106

<pre>Permanently deletes the default object ACL entry for the specified entity on the specified bucket.

107

108

Args:

109

bucket: string, Name of a bucket. (required)

110

entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)

Bu Sun Kim

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

[diff] [blame]

111

provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.

Bu Sun Kim

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

[diff] [blame]

112

userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

117

<code class="details" id="get">get(bucket, entity, provisionalUserProject=None, userProject=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

118

<pre>Returns the default object ACL entry for the specified entity on the specified bucket.

119

120

Args:

121

bucket: string, Name of a bucket. (required)

122

entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)

Bu Sun Kim

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

[diff] [blame]

123

provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.

Bu Sun Kim

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

[diff] [blame]

124

userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

125

126

Returns:

127

An object of the form:

128

129

{ # An access-control entry.

Yoshi Automation Bot

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

[diff] [blame]

130

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

131

"domain": "A String", # The domain associated with the entity, if any.

132

"email": "A String", # The email address associated with the entity, if any.

133

"entity": "A String", # The entity holding the permission, in one of the following forms:

# - user-userId

# - user-email

# - group-groupId

# - group-email

# - domain-domain

# - project-team-projectId

140

# - allUsers

141

# - allAuthenticatedUsers Examples:

142

# - The user liz@example.com would be user-liz@example.com.

143

# - The group example@googlegroups.com would be group-example@googlegroups.com.

144

# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

145

"entityId": "A String", # The ID for the entity, if any.

146

"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.

147

"generation": "A String", # The content generation of the object, if applied to an object.

148

"id": "A String", # The ID of the access-control entry.

149

"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

150

"object": "A String", # The name of the object, if applied to an object.

151

"projectTeam": { # The project team associated with the entity, if any.

152

"projectNumber": "A String", # The project number.

153

"team": "A String", # The team.

154

},

155

"role": "A String", # The access permission for the entity.

156

"selfLink": "A String", # The link to this access-control entry.

157

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

161

<code class="details" id="insert">insert(bucket, body=None, provisionalUserProject=None, userProject=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

162

<pre>Creates a new default object ACL entry on the specified bucket.

163

164

Args:

165

bucket: string, Name of a bucket. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

166

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

167

The object takes the form of:

168

169

{ # An access-control entry.

Bu Sun Kim

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

[diff] [blame]

170

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

171

"domain": "A String", # The domain associated with the entity, if any.

172

"email": "A String", # The email address associated with the entity, if any.

173

"entity": "A String", # The entity holding the permission, in one of the following forms:

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

# - user-userId

# - user-email

# - group-groupId

# - group-email

# - domain-domain

# - project-team-projectId

180

# - allUsers

181

# - allAuthenticatedUsers Examples:

182

# - The user liz@example.com would be user-liz@example.com.

183

# - The group example@googlegroups.com would be group-example@googlegroups.com.

184

# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

Bu Sun Kim

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

[diff] [blame]

185

"entityId": "A String", # The ID for the entity, if any.

186

"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.

187

"generation": "A String", # The content generation of the object, if applied to an object.

188

"id": "A String", # The ID of the access-control entry.

189

"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

190

"object": "A String", # The name of the object, if applied to an object.

191

"projectTeam": { # The project team associated with the entity, if any.

192

"projectNumber": "A String", # The project number.

193

"team": "A String", # The team.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

194

},

Bu Sun Kim

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

[diff] [blame]

195

"role": "A String", # The access permission for the entity.

196

"selfLink": "A String", # The link to this access-control entry.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

197

}

198

Bu Sun Kim

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

[diff] [blame]

199

provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.

Bu Sun Kim

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

[diff] [blame]

200

userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

201

202

Returns:

203

An object of the form:

204

205

{ # An access-control entry.

Yoshi Automation Bot

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

[diff] [blame]

206

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

207

"domain": "A String", # The domain associated with the entity, if any.

208

"email": "A String", # The email address associated with the entity, if any.

209

"entity": "A String", # The entity holding the permission, in one of the following forms:

# - user-userId

# - user-email

# - group-groupId

# - group-email

# - domain-domain

# - project-team-projectId

216

# - allUsers

217

# - allAuthenticatedUsers Examples:

218

# - The user liz@example.com would be user-liz@example.com.

219

# - The group example@googlegroups.com would be group-example@googlegroups.com.

220

# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

221

"entityId": "A String", # The ID for the entity, if any.

222

"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.

223

"generation": "A String", # The content generation of the object, if applied to an object.

224

"id": "A String", # The ID of the access-control entry.

225

"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

226

"object": "A String", # The name of the object, if applied to an object.

227

"projectTeam": { # The project team associated with the entity, if any.

228

"projectNumber": "A String", # The project number.

229

"team": "A String", # The team.

230

},

231

"role": "A String", # The access permission for the entity.

232

"selfLink": "A String", # The link to this access-control entry.

233

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

237

<code class="details" id="list">list(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, provisionalUserProject=None, userProject=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

238

<pre>Retrieves default object ACL entries on the specified bucket.

239

240

Args:

241

bucket: string, Name of a bucket. (required)

Bu Sun Kim

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

[diff] [blame]

242

ifMetagenerationMatch: string, If present, only return default ACL listing if the bucket's current metageneration matches this value.

243

ifMetagenerationNotMatch: string, If present, only return default ACL listing if the bucket's current metageneration does not match the given value.

Bu Sun Kim

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

[diff] [blame]

244

provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.

Bu Sun Kim

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

[diff] [blame]

245

userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

246

247

Returns:

248

An object of the form:

249

250

{ # An access-control list.

Yoshi Automation Bot

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

[diff] [blame]

251

"items": [ # The list of items.

252

{ # An access-control entry.

253

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

254

"domain": "A String", # The domain associated with the entity, if any.

255

"email": "A String", # The email address associated with the entity, if any.

256

"entity": "A String", # The entity holding the permission, in one of the following forms:

# - user-userId

# - user-email

# - group-groupId

# - group-email

# - domain-domain

# - project-team-projectId

263

# - allUsers

264

# - allAuthenticatedUsers Examples:

265

# - The user liz@example.com would be user-liz@example.com.

266

# - The group example@googlegroups.com would be group-example@googlegroups.com.

267

# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

268

"entityId": "A String", # The ID for the entity, if any.

269

"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.

270

"generation": "A String", # The content generation of the object, if applied to an object.

271

"id": "A String", # The ID of the access-control entry.

272

"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

273

"object": "A String", # The name of the object, if applied to an object.

274

"projectTeam": { # The project team associated with the entity, if any.

275

"projectNumber": "A String", # The project number.

276

"team": "A String", # The team.

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

277

},

Yoshi Automation Bot

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

[diff] [blame]

278

"role": "A String", # The access permission for the entity.

279

"selfLink": "A String", # The link to this access-control entry.

280

},

281

],

282

"kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.

283

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

287

<code class="details" id="patch">patch(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</code>

Bu Sun Kim

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

[diff] [blame]

288

<pre>Patches a default object ACL entry on the specified bucket.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

289

290

Args:

291

bucket: string, Name of a bucket. (required)

292

entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

293

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

294

The object takes the form of:

295

296

{ # An access-control entry.

Bu Sun Kim

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

[diff] [blame]

297

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

298

"domain": "A String", # The domain associated with the entity, if any.

299

"email": "A String", # The email address associated with the entity, if any.

300

"entity": "A String", # The entity holding the permission, in one of the following forms:

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

# - user-userId

# - user-email

# - group-groupId

# - group-email

# - domain-domain

# - project-team-projectId

307

# - allUsers

308

# - allAuthenticatedUsers Examples:

309

# - The user liz@example.com would be user-liz@example.com.

310

# - The group example@googlegroups.com would be group-example@googlegroups.com.

311

# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

Bu Sun Kim

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

[diff] [blame]

312

"entityId": "A String", # The ID for the entity, if any.

313

"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.

314

"generation": "A String", # The content generation of the object, if applied to an object.

315

"id": "A String", # The ID of the access-control entry.

316

"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

317

"object": "A String", # The name of the object, if applied to an object.

318

"projectTeam": { # The project team associated with the entity, if any.

319

"projectNumber": "A String", # The project number.

320

"team": "A String", # The team.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

321

},

Bu Sun Kim

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

[diff] [blame]

322

"role": "A String", # The access permission for the entity.

323

"selfLink": "A String", # The link to this access-control entry.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

324

}

325

Bu Sun Kim

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

[diff] [blame]

326

provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.

Bu Sun Kim

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

[diff] [blame]

327

userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

328

329

Returns:

330

An object of the form:

331

332

{ # An access-control entry.

Yoshi Automation Bot

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

[diff] [blame]

333

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

334

"domain": "A String", # The domain associated with the entity, if any.

335

"email": "A String", # The email address associated with the entity, if any.

336

"entity": "A String", # The entity holding the permission, in one of the following forms:

# - user-userId

# - user-email

# - group-groupId

# - group-email

# - domain-domain

# - project-team-projectId

343

# - allUsers

344

# - allAuthenticatedUsers Examples:

345

# - The user liz@example.com would be user-liz@example.com.

346

# - The group example@googlegroups.com would be group-example@googlegroups.com.

347

# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

348

"entityId": "A String", # The ID for the entity, if any.

349

"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.

350

"generation": "A String", # The content generation of the object, if applied to an object.

351

"id": "A String", # The ID of the access-control entry.

352

"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

353

"object": "A String", # The name of the object, if applied to an object.

354

"projectTeam": { # The project team associated with the entity, if any.

355

"projectNumber": "A String", # The project number.

356

"team": "A String", # The team.

357

},

358

"role": "A String", # The access permission for the entity.

359

"selfLink": "A String", # The link to this access-control entry.

360

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

364

<code class="details" id="update">update(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

365

<pre>Updates a default object ACL entry on the specified bucket.

366

367

Args:

368

bucket: string, Name of a bucket. (required)

369

entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

370

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

371

The object takes the form of:

372

373

{ # An access-control entry.

Bu Sun Kim

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

[diff] [blame]

374

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

375

"domain": "A String", # The domain associated with the entity, if any.

376

"email": "A String", # The email address associated with the entity, if any.

377

"entity": "A String", # The entity holding the permission, in one of the following forms:

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

# - user-userId

# - user-email

# - group-groupId

# - group-email

# - domain-domain

# - project-team-projectId

384

# - allUsers

385

# - allAuthenticatedUsers Examples:

386

# - The user liz@example.com would be user-liz@example.com.

387

# - The group example@googlegroups.com would be group-example@googlegroups.com.

388

# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

Bu Sun Kim

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

[diff] [blame]

389

"entityId": "A String", # The ID for the entity, if any.

390

"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.

391

"generation": "A String", # The content generation of the object, if applied to an object.

392

"id": "A String", # The ID of the access-control entry.

393

"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

394

"object": "A String", # The name of the object, if applied to an object.

395

"projectTeam": { # The project team associated with the entity, if any.

396

"projectNumber": "A String", # The project number.

397

"team": "A String", # The team.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

398

},

Bu Sun Kim

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

[diff] [blame]

399

"role": "A String", # The access permission for the entity.

400

"selfLink": "A String", # The link to this access-control entry.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

401

}

402

Bu Sun Kim

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

[diff] [blame]

403

provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.

Bu Sun Kim

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

[diff] [blame]

404

userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

405

406

Returns:

407

An object of the form:

408

409

{ # An access-control entry.

Yoshi Automation Bot

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

[diff] [blame]

410

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

411

"domain": "A String", # The domain associated with the entity, if any.

412

"email": "A String", # The email address associated with the entity, if any.

413

"entity": "A String", # The entity holding the permission, in one of the following forms:

# - user-userId

# - user-email

# - group-groupId

# - group-email

# - domain-domain

# - project-team-projectId

420

# - allUsers

421

# - allAuthenticatedUsers Examples:

422

# - The user liz@example.com would be user-liz@example.com.

423

# - The group example@googlegroups.com would be group-example@googlegroups.com.

424

# - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

425

"entityId": "A String", # The ID for the entity, if any.

426

"etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.

427

"generation": "A String", # The content generation of the object, if applied to an object.

428

"id": "A String", # The ID of the access-control entry.

429

"kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.

430

"object": "A String", # The name of the object, if applied to an object.

431

"projectTeam": { # The project team associated with the entity, if any.

432

"projectNumber": "A String", # The project number.

433

"team": "A String", # The team.

434

},

435

"role": "A String", # The access permission for the entity.

436

"selfLink": "A String", # The link to this access-control entry.

437

}</pre>

Craig Citro