docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/cloudasset_v1beta1.projects.html b/docs/dyn/cloudasset_v1beta1.projects.html
index 58faf93..5774aaf 100644
--- a/docs/dyn/cloudasset_v1beta1.projects.html
+++ b/docs/dyn/cloudasset_v1beta1.projects.html
@@ -126,12 +126,44 @@
# status of the asset and valid from and to time of it.
"deleted": True or False, # If the asset is deleted or not.
"window": { # A time window of (start_time, end_time]. # The time window when the asset data and state was observed.
+ "startTime": "A String", # Start time of the time window (exclusive).
"endTime": "A String", # End time of the time window (inclusive).
# Current timestamp if not specified.
- "startTime": "A String", # Start time of the time window (exclusive).
},
"asset": { # Cloud asset. This includes all Google Cloud Platform resources, # Asset.
# Cloud IAM policies, and other non-GCP assets.
+ "resource": { # Representation of a cloud resource. # Representation of the resource.
+ "version": "A String", # The API version. Example: "v1".
+ "data": { # The content of the resource, in which some sensitive fields are scrubbed
+ # away and may not be present.
+ "a_key": "", # Properties of the object.
+ },
+ "discoveryDocumentUri": "A String", # The URL of the discovery document containing the resource's JSON schema.
+ # For example:
+ # `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`.
+ # It will be left unspecified for resources without a discovery-based API,
+ # such as Cloud Bigtable.
+ "parent": "A String", # The full name of the immediate parent of this resource. See
+ # [Resource
+ # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
+ # for more information.
+ #
+ # For GCP assets, it is the parent resource defined in the [Cloud IAM policy
+ # hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
+ # For example:
+ # `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`.
+ #
+ # For third-party assets, it is up to the users to define.
+ "resourceUrl": "A String", # The REST URL for accessing the resource. An HTTP GET operation using this
+ # URL returns the resource itself.
+ # Example:
+ # `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`.
+ # It will be left unspecified for resources without a REST API.
+ "discoveryName": "A String", # The JSON schema name listed in the discovery document.
+ # Example: "Project". It will be left unspecified for resources (such as
+ # Cloud Bigtable) without a discovery-based API.
+ },
+ "assetType": "A String", # Type of the asset. Example: "google.compute.Disk".
"name": "A String", # The full name of the asset. For example:
# `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
# See [Resource
@@ -148,10 +180,12 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
@@ -168,7 +202,9 @@
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
+ # "members": [
+ # "user:eve@example.com"
+ # ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
@@ -222,6 +258,9 @@
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
@@ -311,50 +350,6 @@
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -402,6 +397,58 @@
],
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ },
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
@@ -417,38 +464,6 @@
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
},
- "resource": { # Representation of a cloud resource. # Representation of the resource.
- "resourceUrl": "A String", # The REST URL for accessing the resource. An HTTP GET operation using this
- # URL returns the resource itself.
- # Example:
- # `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`.
- # It will be left unspecified for resources without a REST API.
- "discoveryName": "A String", # The JSON schema name listed in the discovery document.
- # Example: "Project". It will be left unspecified for resources (such as
- # Cloud Bigtable) without a discovery-based API.
- "version": "A String", # The API version. Example: "v1".
- "data": { # The content of the resource, in which some sensitive fields are scrubbed
- # away and may not be present.
- "a_key": "", # Properties of the object.
- },
- "discoveryDocumentUri": "A String", # The URL of the discovery document containing the resource's JSON schema.
- # For example:
- # `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`.
- # It will be left unspecified for resources without a discovery-based API,
- # such as Cloud Bigtable.
- "parent": "A String", # The full name of the immediate parent of this resource. See
- # [Resource
- # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
- # for more information.
- #
- # For GCP assets, it is the parent resource defined in the [Cloud IAM policy
- # hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
- # For example:
- # `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`.
- #
- # For third-party assets, it is up to the users to define.
- },
- "assetType": "A String", # Type of the asset. Example: "google.compute.Disk".
},
},
],
@@ -460,7 +475,10 @@
<pre>Exports assets with time and resource types to a given Cloud Storage
location. The output format is newline-delimited JSON.
This API implements the google.longrunning.Operation API allowing you
-to keep track of the export.
+to keep track of the export. We recommend intervals of at least 2 seconds
+with exponential retry to poll the export operation result. For
+regular-size resource parent, the export operation usually finishes within
+5 minutes.
Args:
parent: string, Required. The relative name of the root asset. This can only be an
@@ -471,6 +489,13 @@
The object takes the form of:
{ # Export asset request.
+ "assetTypes": [ # A list of asset types of which to take a snapshot for. For example:
+ # "google.compute.Disk". If specified, only matching assets will be returned.
+ # See [Introduction to Cloud Asset
+ # Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
+ # for all supported asset types.
+ "A String",
+ ],
"readTime": "A String", # Timestamp to take an asset snapshot. This can only be set to a timestamp
# between 2018-10-02 UTC (inclusive) and the current time. If not specified,
# the current time will be used. Due to delays in resource data collection
@@ -496,13 +521,6 @@
# "gs://bucket_name/object_name_prefix" already exists.
},
},
- "assetTypes": [ # A list of asset types of which to take a snapshot for. For example:
- # "google.compute.Disk". If specified, only matching assets will be returned.
- # See [Introduction to Cloud Asset
- # Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
- # for all supported asset types.
- "A String",
- ],
}
x__xgafv: string, V1 error format.
@@ -515,6 +533,33 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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.
+ "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.
+ },
+ "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.
"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
@@ -528,33 +573,6 @@
"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>