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/accesscontextmanager_v1beta.accessPolicies.html b/docs/dyn/accesscontextmanager_v1beta.accessPolicies.html
index cd42ea8..47dce0e 100644
--- a/docs/dyn/accesscontextmanager_v1beta.accessPolicies.html
+++ b/docs/dyn/accesscontextmanager_v1beta.accessPolicies.html
@@ -94,7 +94,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get an AccessPolicy by name.</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all AccessPolicies under a</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -120,12 +120,12 @@
# define regions of services able to freely pass data within a perimeter). An
# access policy is globally visible within an organization, and the
# restrictions it specifies apply to all projects within an organization.
- "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
- # `accessPolicies/{policy_id}`
- "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
+ "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
# Hierarchy. Currently immutable once created. Format:
# `organizations/{organization_id}`
- "title": "A String", # Required. Human readable title. Does not affect behavior.
+ "title": "A String", # Required. Human readable title. Does not affect behavior.
+ "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
+ # `accessPolicies/{policy_id}`
}
x__xgafv: string, V1 error format.
@@ -138,34 +138,7 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -173,11 +146,38 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
}</pre>
</div>
@@ -202,34 +202,7 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -237,11 +210,38 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
}</pre>
</div>
@@ -266,17 +266,17 @@
# define regions of services able to freely pass data within a perimeter). An
# access policy is globally visible within an organization, and the
# restrictions it specifies apply to all projects within an organization.
- "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
- # `accessPolicies/{policy_id}`
- "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
+ "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
# Hierarchy. Currently immutable once created. Format:
# `organizations/{organization_id}`
- "title": "A String", # Required. Human readable title. Does not affect behavior.
+ "title": "A String", # Required. Human readable title. Does not affect behavior.
+ "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
+ # `accessPolicies/{policy_id}`
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>List all AccessPolicies under a
container.
@@ -286,9 +286,9 @@
Format:
`organizations/{org_id}`
- pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100.
pageToken: string, Next page token for the next batch of AccessPolicy instances. Defaults to
the first page of results.
+ pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -298,20 +298,20 @@
An object of the form:
{ # A response to `ListAccessPoliciesRequest`.
- "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
+ "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
# empty, no further results remain.
- "accessPolicies": [ # List of the AccessPolicy instances.
+ "accessPolicies": [ # List of the AccessPolicy instances.
{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
# attributes to use Google Cloud services) and `ServicePerimeters` (which
# define regions of services able to freely pass data within a perimeter). An
# access policy is globally visible within an organization, and the
# restrictions it specifies apply to all projects within an organization.
- "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
- # `accessPolicies/{policy_id}`
- "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
+ "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
# Hierarchy. Currently immutable once created. Format:
# `organizations/{organization_id}`
- "title": "A String", # Required. Human readable title. Does not affect behavior.
+ "title": "A String", # Required. Human readable title. Does not affect behavior.
+ "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
+ # `accessPolicies/{policy_id}`
},
],
}</pre>
@@ -326,7 +326,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>
@@ -350,12 +350,12 @@
# define regions of services able to freely pass data within a perimeter). An
# access policy is globally visible within an organization, and the
# restrictions it specifies apply to all projects within an organization.
- "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
- # `accessPolicies/{policy_id}`
- "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
+ "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
# Hierarchy. Currently immutable once created. Format:
# `organizations/{organization_id}`
- "title": "A String", # Required. Human readable title. Does not affect behavior.
+ "title": "A String", # Required. Human readable title. Does not affect behavior.
+ "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
+ # `accessPolicies/{policy_id}`
}
updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
@@ -369,34 +369,7 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -404,11 +377,38 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
}</pre>
</div>