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

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

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

Bu Sun Kim

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

[diff] [blame^]

87

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

Bu Sun Kim

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

[diff] [blame]

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

Dan O'Meara

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

[diff] [blame]

94

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

Bu Sun Kim

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

[diff] [blame]

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:

Dan O'Meara

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

[diff] [blame]

102

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

103

The object takes the form of:

104

105

{ # Request to approve an ApprovalRequest.

Bu Sun Kim

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

[diff] [blame^]

106

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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame^]

118

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

119

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

120

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

121

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

Bu Sun Kim

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

[diff] [blame]

122

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

123

# a region code instead of a country code.

124

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

125

# <ol>

126

# <li>ASI: Asia</li>

127

# <li>EUR: Europe</li>

128

# <li>OCE: Oceania</li>

129

# <li>AFR: Africa</li>

130

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

131

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

132

# <li>ANT: Antarctica</li>

133

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

134

# </ol>

Bu Sun Kim

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

[diff] [blame^]

135

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

136

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

Dan O'Meara

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

[diff] [blame]

137

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

138

# of a country code.

139

# Possible Region Codes:

140

# <ol>

141

# <li>ASI: Asia</li>

142

# <li>EUR: Europe</li>

143

# <li>OCE: Oceania</li>

144

# <li>AFR: Africa</li>

145

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

146

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

147

# <li>ANT: Antarctica</li>

148

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

149

# </ol>

Bu Sun Kim

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

[diff] [blame]

150

},

Bu Sun Kim

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

[diff] [blame^]

151

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

152

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

153

},

154

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

155

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

156

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

157

# resource name is defined at

158

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

159

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

160

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

161

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

162

# resource name specification.

163

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

164

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

165

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

166

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

167

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

168

},

169

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

170

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

171

# requested.

172

},

173

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

174

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

175

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

176

},

Bu Sun Kim

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

[diff] [blame]

}</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.

Bu Sun Kim

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

[diff] [blame^]

210

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

211

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

212

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

213

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

Bu Sun Kim

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

[diff] [blame]

214

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

215

# a region code instead of a country code.

216

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

217

# <ol>

218

# <li>ASI: Asia</li>

219

# <li>EUR: Europe</li>

220

# <li>OCE: Oceania</li>

221

# <li>AFR: Africa</li>

222

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

223

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

224

# <li>ANT: Antarctica</li>

225

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

226

# </ol>

Bu Sun Kim

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

[diff] [blame^]

227

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

228

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

Dan O'Meara

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

[diff] [blame]

229

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

230

# of a country code.

231

# Possible Region Codes:

232

# <ol>

233

# <li>ASI: Asia</li>

234

# <li>EUR: Europe</li>

235

# <li>OCE: Oceania</li>

236

# <li>AFR: Africa</li>

237

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

238

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

239

# <li>ANT: Antarctica</li>

240

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

241

# </ol>

Bu Sun Kim

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

[diff] [blame]

242

},

Bu Sun Kim

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

[diff] [blame^]

243

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

244

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

245

},

246

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

247

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

248

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

249

# resource name is defined at

250

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

251

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

252

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

253

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

254

# resource name specification.

255

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

256

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

257

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

258

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

259

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

260

},

261

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

262

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

263

# requested.

264

},

265

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

266

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

267

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

268

},

Bu Sun Kim

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

[diff] [blame]

}</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.

Bu Sun Kim

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

[diff] [blame^]

287

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

288

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

289

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

290

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

Bu Sun Kim

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

[diff] [blame]

291

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

292

# a region code instead of a country code.

293

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

294

# <ol>

295

# <li>ASI: Asia</li>

296

# <li>EUR: Europe</li>

297

# <li>OCE: Oceania</li>

298

# <li>AFR: Africa</li>

299

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

300

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

301

# <li>ANT: Antarctica</li>

302

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

303

# </ol>

Bu Sun Kim

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

[diff] [blame^]

304

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

305

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

Dan O'Meara

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

[diff] [blame]

306

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

307

# of a country code.

308

# Possible Region Codes:

309

# <ol>

310

# <li>ASI: Asia</li>

311

# <li>EUR: Europe</li>

312

# <li>OCE: Oceania</li>

313

# <li>AFR: Africa</li>

314

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

315

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

316

# <li>ANT: Antarctica</li>

317

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

318

# </ol>

Bu Sun Kim

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

[diff] [blame]

319

},

Bu Sun Kim

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

[diff] [blame^]

320

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

321

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

322

},

323

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

324

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

325

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

326

# resource name is defined at

327

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

328

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

329

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

330

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

331

# resource name specification.

332

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

333

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

334

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

335

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

336

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

337

},

338

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

339

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

340

# requested.

341

},

342

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

343

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

344

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

345

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

350

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

Bu Sun Kim

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

[diff] [blame]

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:

Bu Sun Kim

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

[diff] [blame^]

356

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

357

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

Bu Sun Kim

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

[diff] [blame]

358

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

Dan O'Meara

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

[diff] [blame]

359

pageSize: integer, Requested page size.

Bu Sun Kim

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

[diff] [blame]

360

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

361

following values:

Dan O'Meara

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

[diff] [blame]

362

<ol>

363

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

364

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

365

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

366

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

367

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

368

</ol>

Bu Sun Kim

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

[diff] [blame^]

369

x__xgafv: string, V1 error format.

370

Allowed values

371

1 - v1 error format

372

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

373

374

Returns:

375

An object of the form:

376

377

{ # Response to listing of ApprovalRequest objects.

Bu Sun Kim

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

[diff] [blame^]

378

"approvalRequests": [ # Approval request details.

Bu Sun Kim

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

[diff] [blame]

379

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

Bu Sun Kim

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

[diff] [blame^]

380

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

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

Bu Sun Kim

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

[diff] [blame]

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:

Dan O'Meara

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

[diff] [blame]

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>

Bu Sun Kim

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

[diff] [blame^]

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

Dan O'Meara

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

[diff] [blame]

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>

Bu Sun Kim

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

[diff] [blame]

412

},

Bu Sun Kim