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

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

[diff] [blame]

79

<p class="firstline">Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.</p>

80

81

<code><a href="#close">close()</a></code></p>

82

<p class="firstline">Close httplib2 connections.</p>

Bu Sun Kim

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

[diff] [blame]

83

84

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

Dmitry Frenkel

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

[diff] [blame]

85

<p class="firstline">Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.</p>

Bu Sun Kim

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

[diff] [blame]

86

87

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

88

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

89

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

90

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

Dmitry Frenkel

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

[diff] [blame]

91

<p class="firstline">Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.</p>

Bu Sun Kim

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

[diff] [blame]

92

93

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

94

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

95

<h3>Method Details</h3>

96

97

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

Dmitry Frenkel

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

[diff] [blame]

98

<pre>Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Bu Sun Kim

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

[diff] [blame]

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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

118

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

119

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

120

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.

121

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

122

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

123

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

124

},

125

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

126

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location

127

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location

128

},

129

"name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".

Bu Sun Kim

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

[diff] [blame]

130

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

131

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

132

"implicit": True or False, # This field will be true if the ApprovalRequest was implcitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

133

},

134

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

135

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

136

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

137

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

138

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

139

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

140

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

145

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

146

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

150

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

Dmitry Frenkel

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

[diff] [blame]

151

<pre>Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Bu Sun Kim

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

[diff] [blame]

Args:

body: object, The request body.

156

The object takes the form of:

157

158

{ # Request to dismiss an approval request.

159

}

160

161

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

168

169

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

170

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

171

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

172

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.

173

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

174

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

175

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

176

},

177

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

178

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location

179

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location

180

},

181

"name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".

Bu Sun Kim

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

[diff] [blame]

182

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

183

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

184

"implicit": True or False, # This field will be true if the ApprovalRequest was implcitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

185

},

186

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

187

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

188

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

189

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

190

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

191

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

192

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

198

<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:

209

210

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

211

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

212

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

213

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.

214

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

215

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

216

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

217

},

218

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

219

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location

220

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location

221

},

222

"name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".

Bu Sun Kim

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

[diff] [blame]

223

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

224

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

225

"implicit": True or False, # This field will be true if the ApprovalRequest was implcitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

226

},

227

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

228

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

229

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

230

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

231

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

232

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

233

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

238

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

Dmitry Frenkel

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

[diff] [blame]

239

<pre>Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

Bu Sun Kim

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

[diff] [blame]

240

241

Args:

Dmitry Frenkel

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

[diff] [blame]

242

parent: string, The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}". (required)

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

243

filter: string, A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that . are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

244

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

245

pageSize: integer, Requested page size.

Bu Sun Kim

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

[diff] [blame]

246

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

253

254

{ # Response to listing of ApprovalRequest objects.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

255

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

Bu Sun Kim

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

[diff] [blame]

256

"approvalRequests": [ # Approval request details.

257

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

258

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

259

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

260

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.

261

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

262

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

263

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

264

},

265

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

266

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location

267

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location

268

},

269

"name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".

Bu Sun Kim

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

[diff] [blame]

270

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

271

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

272

"implicit": True or False, # This field will be true if the ApprovalRequest was implcitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

273

},

274

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

275

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

276

},

Yoshi Automation Bot