docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/accessapproval_v1beta1.projects.approvalRequests.html b/docs/dyn/accessapproval_v1beta1.projects.approvalRequests.html
index 63a0b6e..987adcf 100644
--- a/docs/dyn/accessapproval_v1beta1.projects.approvalRequests.html
+++ b/docs/dyn/accessapproval_v1beta1.projects.approvalRequests.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an approval request. Returns NOT_FOUND if the request does not exist.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists approval requests associated with a project, folder, or organization.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -103,7 +103,7 @@
The object takes the form of:
{ # Request to approve an ApprovalRequest.
- "expireTime": "A String", # The expiration time of this approval.
+ "expireTime": "A String", # The expiration time of this approval.
}
x__xgafv: string, V1 error format.
@@ -115,36 +115,10 @@
An object of the form:
{ # A request for the customer to approve access to a resource.
- "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
- "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
- # requested.
- },
- "requestTime": "A String", # The time at which approval was requested.
- "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.
- "name": "A String", # The resource name of the request. Format is
- # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
- "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
- "dismissTime": "A String", # The time at which the approval request was dismissed.
- },
- "requestedReason": { # The justification for which approval is being requested.
- "type": "A String", # Type of access justification.
- "detail": "A String", # More detail about certain reason types. See comments for each type above.
- },
- "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.
- "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
- "expireTime": "A String", # The time at which the approval expires.
- "approveTime": "A String", # The time at which approval was granted.
- },
- "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
- "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
+ "requestTime": "A String", # The time at which approval was requested.
+ "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
+ "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:
@@ -158,8 +132,8 @@
# <li>ANT: Antarctica</li>
# <li>ANY: Any location</li>
# </ol>
- "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
+ "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:
@@ -174,6 +148,32 @@
# <li>ANY: Any location</li>
# </ol>
},
+ "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
+ "dismissTime": "A String", # The time at which the approval request was dismissed.
+ },
+ "name": "A String", # The resource name of the request. Format is
+ # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
+ "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.
+ "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.
+ "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
+ "expireTime": "A String", # The time at which the approval expires.
+ "approveTime": "A String", # The time at which approval was granted.
+ },
+ "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
+ "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
+ # requested.
+ },
+ "requestedReason": { # The justification for which approval is being requested.
+ "type": "A String", # Type of access justification.
+ "detail": "A String", # More detail about certain reason types. See comments for each type above.
+ },
}</pre>
</div>
@@ -207,36 +207,10 @@
An object of the form:
{ # A request for the customer to approve access to a resource.
- "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
- "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
- # requested.
- },
- "requestTime": "A String", # The time at which approval was requested.
- "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.
- "name": "A String", # The resource name of the request. Format is
- # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
- "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
- "dismissTime": "A String", # The time at which the approval request was dismissed.
- },
- "requestedReason": { # The justification for which approval is being requested.
- "type": "A String", # Type of access justification.
- "detail": "A String", # More detail about certain reason types. See comments for each type above.
- },
- "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.
- "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
- "expireTime": "A String", # The time at which the approval expires.
- "approveTime": "A String", # The time at which approval was granted.
- },
- "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
- "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
+ "requestTime": "A String", # The time at which approval was requested.
+ "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
+ "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:
@@ -250,8 +224,8 @@
# <li>ANT: Antarctica</li>
# <li>ANY: Any location</li>
# </ol>
- "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
+ "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:
@@ -266,6 +240,32 @@
# <li>ANY: Any location</li>
# </ol>
},
+ "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
+ "dismissTime": "A String", # The time at which the approval request was dismissed.
+ },
+ "name": "A String", # The resource name of the request. Format is
+ # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
+ "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.
+ "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.
+ "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
+ "expireTime": "A String", # The time at which the approval expires.
+ "approveTime": "A String", # The time at which approval was granted.
+ },
+ "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
+ "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
+ # requested.
+ },
+ "requestedReason": { # The justification for which approval is being requested.
+ "type": "A String", # Type of access justification.
+ "detail": "A String", # More detail about certain reason types. See comments for each type above.
+ },
}</pre>
</div>
@@ -284,36 +284,10 @@
An object of the form:
{ # A request for the customer to approve access to a resource.
- "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
- "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
- # requested.
- },
- "requestTime": "A String", # The time at which approval was requested.
- "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.
- "name": "A String", # The resource name of the request. Format is
- # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
- "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
- "dismissTime": "A String", # The time at which the approval request was dismissed.
- },
- "requestedReason": { # The justification for which approval is being requested.
- "type": "A String", # Type of access justification.
- "detail": "A String", # More detail about certain reason types. See comments for each type above.
- },
- "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.
- "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
- "expireTime": "A String", # The time at which the approval expires.
- "approveTime": "A String", # The time at which approval was granted.
- },
- "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
- "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
+ "requestTime": "A String", # The time at which approval was requested.
+ "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
+ "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:
@@ -327,8 +301,8 @@
# <li>ANT: Antarctica</li>
# <li>ANY: Any location</li>
# </ol>
- "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
+ "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:
@@ -343,23 +317,45 @@
# <li>ANY: Any location</li>
# </ol>
},
+ "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
+ "dismissTime": "A String", # The time at which the approval request was dismissed.
+ },
+ "name": "A String", # The resource name of the request. Format is
+ # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
+ "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.
+ "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.
+ "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
+ "expireTime": "A String", # The time at which the approval expires.
+ "approveTime": "A String", # The time at which approval was granted.
+ },
+ "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
+ "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
+ # requested.
+ },
+ "requestedReason": { # The justification for which approval is being requested.
+ "type": "A String", # Type of access justification.
+ "detail": "A String", # More detail about certain reason types. See comments for each type above.
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
<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.
Args:
- parent: string, The parent resource. This may be "projects/{project_id}",
-"folders/{folder_id}", or "organizations/{organization_id}". (required)
+ parent: string, The parent resource. This may be "projects/{project_id}",
+"folders/{folder_id}", or "organizations/{organization_id}". (required)
pageToken: string, A token identifying the page of results to return.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
pageSize: integer, Requested page size.
filter: string, A filter on the type of approval requests to retrieve. Must be one of the
following values:
@@ -370,44 +366,21 @@
<li>ACTIVE: Only active (i.e. currently approved) requests.</li>
<li>DISMISSED: Only dismissed (including expired) requests.</li>
</ol>
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Response to listing of ApprovalRequest objects.
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more.
- "approvalRequests": [ # Approval request details.
+ "approvalRequests": [ # Approval request details.
{ # A request for the customer to approve access to a resource.
- "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
- "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
- # requested.
- },
- "requestTime": "A String", # The time at which approval was requested.
- "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.
- "name": "A String", # The resource name of the request. Format is
- # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
- "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
- "dismissTime": "A String", # The time at which the approval request was dismissed.
- },
- "requestedReason": { # The justification for which approval is being requested.
- "type": "A String", # Type of access justification.
- "detail": "A String", # More detail about certain reason types. See comments for each type above.
- },
- "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.
- "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
- "expireTime": "A String", # The time at which the approval expires.
- "approveTime": "A String", # The time at which approval was granted.
- },
- "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
- "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
+ "requestTime": "A String", # The time at which approval was requested.
+ "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
+ "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:
@@ -421,8 +394,8 @@
# <li>ANT: Antarctica</li>
# <li>ANY: Any location</li>
# </ol>
- "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
+ "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:
@@ -437,8 +410,35 @@
# <li>ANY: Any location</li>
# </ol>
},
+ "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
+ "dismissTime": "A String", # The time at which the approval request was dismissed.
+ },
+ "name": "A String", # The resource name of the request. Format is
+ # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
+ "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.
+ "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.
+ "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
+ "expireTime": "A String", # The time at which the approval expires.
+ "approveTime": "A String", # The time at which approval was granted.
+ },
+ "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
+ "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
+ # requested.
+ },
+ "requestedReason": { # The justification for which approval is being requested.
+ "type": "A String", # Type of access justification.
+ "detail": "A String", # More detail about certain reason types. See comments for each type above.
+ },
},
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more.
}</pre>
</div>
@@ -451,7 +451,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>