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

<h1><a href="accessapproval_v1.html">Access Approval API</a> . <a href="accessapproval_v1.projects.html">projects</a> . <a href="accessapproval_v1.projects.approvalRequests.html">approvalRequests</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

<p class="firstline">Approves a request and returns the updated ApprovalRequest.</p>

80

81

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

82

<p class="firstline">Dismisses a request. Returns the updated ApprovalRequest.</p>

83

84

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

85

<p class="firstline">Gets an approval request. Returns NOT_FOUND if the request does not exist.</p>

86

87

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

88

<p class="firstline">Lists approval requests associated with a project, folder, or organization.</p>

89

90

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

91

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

92

<h3>Method Details</h3>

93

94

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

95

<pre>Approves a request and returns the updated ApprovalRequest.

96

97

Returns NOT_FOUND if the request does not exist. Returns

98

FAILED_PRECONDITION if the request exists but is not in a pending state.

Args:

body: object, The request body.

103

The object takes the form of:

104

105

{ # Request to approve an ApprovalRequest.

106

"expireTime": "A String", # The expiration time of this approval.

107

}

108

109

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

116

117

{ # A request for the customer to approve access to a resource.

118

"requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.

119

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A

120

# two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or

121

# a region code. In some limited situations Google systems may refer refer to

122

# a region code instead of a country code.

123

# Possible Region Codes:

124

# <ol>

125

# <li>ASI: Asia</li>

126

# <li>EUR: Europe</li>

127

# <li>OCE: Oceania</li>

128

# <li>AFR: Africa</li>

129

# <li>NAM: North America</li>

130

# <li>SAM: South America</li>

131

# <li>ANT: Antarctica</li>

132

# <li>ANY: Any location</li>

133

# </ol>

134

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code

135

# (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some

136

# limited situations Google systems may refer refer to a region code instead

137

# of a country code.

138

# Possible Region Codes:

139

# <ol>

140

# <li>ASI: Asia</li>

141

# <li>EUR: Europe</li>

142

# <li>OCE: Oceania</li>

143

# <li>AFR: Africa</li>

144

# <li>NAM: North America</li>

145

# <li>SAM: South America</li>

146

# <li>ANT: Antarctica</li>

147

# <li>ANY: Any location</li>

148

# </ol>

149

},

150

"dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.

151

"dismissTime": "A String", # The time at which the approval request was dismissed.

152

},

153

"name": "A String", # The resource name of the request. Format is

154

# "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".

155

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the

156

# resource name is defined at

157

# https://cloud.google.com/apis/design/resource_names. The resource name here

158

# may either be a "full" resource name (e.g.

159

# "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"

160

# resource name (e.g. "shelves/shelf1/books/book2") as described in the

161

# resource name specification.

162

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,

163

# access will be granted from the time of approval until the expiration time.

164

"approve": { # A decision that has been made to approve access to a resource. # Access was approved.

165

"expireTime": "A String", # The time at which the approval expires.

166

"approveTime": "A String", # The time at which approval was granted.

167

},

168

"requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.

169

"excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being

170

# requested.

171

},

172

"requestedReason": { # The justification for which approval is being requested.

173

"type": "A String", # Type of access justification.

174

"detail": "A String", # More detail about certain reason types. See comments for each type above.

175

},

176

"requestTime": "A String", # The time at which approval was requested.

}</pre>

</div>

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

182

<pre>Dismisses a request. Returns the updated ApprovalRequest.

183

184

NOTE: This does not deny access to the resource if another request has been

185

made and approved. It is equivalent in effect to ignoring the request

186

altogether.

187

188

Returns NOT_FOUND if the request does not exist.

189

190

Returns FAILED_PRECONDITION if the request exists but is not in a pending

state.

Args:

body: object, The request body.

196

The object takes the form of:

197

198

{ # Request to dismiss an approval request.

199

}

200

201

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

208

209

{ # A request for the customer to approve access to a resource.

210

"requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.

211

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A

212

# two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or

213

# a region code. In some limited situations Google systems may refer refer to

214

# a region code instead of a country code.

215

# Possible Region Codes:

216

# <ol>

217

# <li>ASI: Asia</li>

218

# <li>EUR: Europe</li>

219

# <li>OCE: Oceania</li>

220

# <li>AFR: Africa</li>

221

# <li>NAM: North America</li>

222

# <li>SAM: South America</li>

223

# <li>ANT: Antarctica</li>

224

# <li>ANY: Any location</li>

225

# </ol>

226

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code

227

# (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some

228

# limited situations Google systems may refer refer to a region code instead

229

# of a country code.

230

# Possible Region Codes:

231

# <ol>

232

# <li>ASI: Asia</li>

233

# <li>EUR: Europe</li>

234

# <li>OCE: Oceania</li>

235

# <li>AFR: Africa</li>

236

# <li>NAM: North America</li>

237

# <li>SAM: South America</li>

238

# <li>ANT: Antarctica</li>

239

# <li>ANY: Any location</li>

240

# </ol>

241

},

242

"dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.

243

"dismissTime": "A String", # The time at which the approval request was dismissed.

244

},

245

"name": "A String", # The resource name of the request. Format is

246

# "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".

247

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the

248

# resource name is defined at

249

# https://cloud.google.com/apis/design/resource_names. The resource name here

250

# may either be a "full" resource name (e.g.

251

# "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"

252

# resource name (e.g. "shelves/shelf1/books/book2") as described in the

253

# resource name specification.

254

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,

255

# access will be granted from the time of approval until the expiration time.

256

"approve": { # A decision that has been made to approve access to a resource. # Access was approved.

257

"expireTime": "A String", # The time at which the approval expires.

258

"approveTime": "A String", # The time at which approval was granted.

259

},

260

"requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.

261

"excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being

262

# requested.

263

},

264

"requestedReason": { # The justification for which approval is being requested.

265

"type": "A String", # Type of access justification.

266

"detail": "A String", # More detail about certain reason types. See comments for each type above.

267

},

268

"requestTime": "A String", # The time at which approval was requested.

}</pre>

</div>

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

274

<pre>Gets an approval request. Returns NOT_FOUND if the request does not exist.

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

285

286

{ # A request for the customer to approve access to a resource.

287

"requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.

288

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A

289

# two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or

290

# a region code. In some limited situations Google systems may refer refer to

291

# a region code instead of a country code.

292

# Possible Region Codes:

293

# <ol>

294

# <li>ASI: Asia</li>

295

# <li>EUR: Europe</li>

296

# <li>OCE: Oceania</li>

297

# <li>AFR: Africa</li>

298

# <li>NAM: North America</li>

299

# <li>SAM: South America</li>

300

# <li>ANT: Antarctica</li>

301

# <li>ANY: Any location</li>

302

# </ol>

303

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code

304

# (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some

305

# limited situations Google systems may refer refer to a region code instead

306

# of a country code.

307

# Possible Region Codes:

308

# <ol>

309

# <li>ASI: Asia</li>

310

# <li>EUR: Europe</li>

311

# <li>OCE: Oceania</li>

312

# <li>AFR: Africa</li>

313

# <li>NAM: North America</li>

314

# <li>SAM: South America</li>

315

# <li>ANT: Antarctica</li>

316

# <li>ANY: Any location</li>

317

# </ol>

318

},

319

"dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.

320

"dismissTime": "A String", # The time at which the approval request was dismissed.

321

},

322

"name": "A String", # The resource name of the request. Format is

323

# "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".

324

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the

325

# resource name is defined at

326

# https://cloud.google.com/apis/design/resource_names. The resource name here

327

# may either be a "full" resource name (e.g.

328

# "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"

329

# resource name (e.g. "shelves/shelf1/books/book2") as described in the

330

# resource name specification.

331

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,

332

# access will be granted from the time of approval until the expiration time.

333

"approve": { # A decision that has been made to approve access to a resource. # Access was approved.

334

"expireTime": "A String", # The time at which the approval expires.

335

"approveTime": "A String", # The time at which approval was granted.

336

},

337

"requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.

338

"excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being

339

# requested.

340

},

341

"requestedReason": { # The justification for which approval is being requested.

342

"type": "A String", # Type of access justification.

343

"detail": "A String", # More detail about certain reason types. See comments for each type above.

344

},

345

"requestTime": "A String", # The time at which approval was requested.

}</pre>

</div>

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

351

<pre>Lists approval requests associated with a project, folder, or organization.

352

Approval requests can be filtered by state (pending, active, dismissed).

353

The order is reverse chronological.

354

355

Args:

356

parent: string, The parent resource. This may be "projects/{project_id}",

357

"folders/{folder_id}", or "organizations/{organization_id}". (required)

358

filter: string, A filter on the type of approval requests to retrieve. Must be one of the

359

following values:

360

<ol>

361

<li>[not set]: Requests that are pending or have active approvals.</li>

362

<li>ALL: All requests.</li>

363

<li>PENDING: Only pending requests.</li>

364

<li>ACTIVE: Only active (i.e. currently approved) requests.</li>

365

<li>DISMISSED: Only dismissed (including expired) requests.</li>

366

</ol>

367

pageToken: string, A token identifying the page of results to return.

368

pageSize: integer, Requested page size.

369

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

376

377

{ # Response to listing of ApprovalRequest objects.

378

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

379

"approvalRequests": [ # Approval request details.

380

{ # A request for the customer to approve access to a resource.

381

"requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.

382

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A

383

# two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or

384

# a region code. In some limited situations Google systems may refer refer to

385

# a region code instead of a country code.

386

# Possible Region Codes:

387

# <ol>

388

# <li>ASI: Asia</li>

389

# <li>EUR: Europe</li>

390

# <li>OCE: Oceania</li>

391

# <li>AFR: Africa</li>

392

# <li>NAM: North America</li>

393

# <li>SAM: South America</li>

394

# <li>ANT: Antarctica</li>

395

# <li>ANY: Any location</li>

396

# </ol>

397

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code

398

# (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some

399

# limited situations Google systems may refer refer to a region code instead

400

# of a country code.

401

# Possible Region Codes:

402

# <ol>

403

# <li>ASI: Asia</li>

404

# <li>EUR: Europe</li>

405

# <li>OCE: Oceania</li>

406

# <li>AFR: Africa</li>

407

# <li>NAM: North America</li>

408

# <li>SAM: South America</li>

409

# <li>ANT: Antarctica</li>

410

# <li>ANY: Any location</li>

411

# </ol>

412

},

413

"dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.

414

"dismissTime": "A String", # The time at which the approval request was dismissed.

415

},

416

"name": "A String", # The resource name of the request. Format is

417

# "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".

418

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the

419

# resource name is defined at

420

# https://cloud.google.com/apis/design/resource_names. The resource name here

421

# may either be a "full" resource name (e.g.

422

# "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"

423

# resource name (e.g. "shelves/shelf1/books/book2") as described in the

424

# resource name specification.

425

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,

426

# access will be granted from the time of approval until the expiration time.

427

"approve": { # A decision that has been made to approve access to a resource. # Access was approved.

428

"expireTime": "A String", # The time at which the approval expires.

429

"approveTime": "A String", # The time at which approval was granted.

430

},

431

"requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.

432

"excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being

433

# requested.

434

},

435

"requestedReason": { # The justification for which approval is being requested.

436

"type": "A String", # Type of access justification.

437

"detail": "A String", # More detail about certain reason types. See comments for each type above.