google-cloud-asset-v1 0.27.0 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce8dc4fea3414af0a84ee4b12cf7c991b4a6bd44dc1a86339cc70ffb514bad35
-  data.tar.gz: 3798fd9b888bb17b535f979a31e982b70a95c8111ab979961e8b044eced9b95d
+  metadata.gz: c67b73d598930bfc47dd2e882d34d13cec911b3ea0ce52056759e85ef3a44208
+  data.tar.gz: fab0851234a71440509abaf9d2aa972adc1f8cc44c9224a57e93a27d185aeff6
 SHA512:
-  metadata.gz: e8f68cbe594e330ae2029da80fafe4a049ec88709ca9de00d38100b8c574c0f722be312914d8f0e50c541d77d3e9e1bf8f5e130b8ccc6b2345d7f186c857f2fb
-  data.tar.gz: 8457d1254fb5b7bc87c4b2f379de5bcc56c88838a8956bd3980525e7f34d05b00c929ad2f2aefc2e64fc63d8c13a675a057474a5d630e6db4afd829a8d1555fd
+  metadata.gz: 1aa714630a9020b57a30a5d2079ec5eb6cf75a7620d6dcc6e2219f677d0e724c027ce4bdca0ecd529ca621e75d4b80a1d49ef967fd5a4584d9b6cbeab30afdb0
+  data.tar.gz: d94d925daefa019d4e2a64f1f59f73c106662c258f6b0c0b03d585ac5e4dbb6380141602898cbdad407cf446e5b573ca24d3c5b19121aecb0e73a8310005354e

data/lib/google/cloud/asset/v1/asset_service/client.rb

@@ -1174,54 +1174,82 @@ module Google
             #     Examples:
             #
             #     * `name:Important` to find Google Cloud resources whose name contains
-            #       "Important" as a word.
+            #       `Important` as a word.
             #     * `name=Important` to find the Google Cloud resource whose name is exactly
-            #       "Important".
+            #       `Important`.
             #     * `displayName:Impor*` to find Google Cloud resources whose display name
-            #       contains "Impor" as a prefix of any word in the field.
+            #       contains `Impor` as a prefix of any word in the field.
             #     * `location:us-west*` to find Google Cloud resources whose location
-            #       contains both "us" and "west" as prefixes.
-            #     * `labels:prod` to find Google Cloud resources whose labels contain "prod"
+            #       contains both `us` and `west` as prefixes.
+            #     * `labels:prod` to find Google Cloud resources whose labels contain `prod`
             #       as a key or value.
-            #     * `labels.env:prod` to find Google Cloud resources that have a label "env"
-            #       and its value is "prod".
-            #     * `labels.env:*` to find Google Cloud resources that have a label "env".
+            #     * `labels.env:prod` to find Google Cloud resources that have a label `env`
+            #       and its value is `prod`.
+            #     * `labels.env:*` to find Google Cloud resources that have a label `env`.
+            #     * `tagKeys:env` to find Google Cloud resources that have directly
+            #       attached tags where the
+            #       [`TagKey.namespacedName`](https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey)
+            #       contains `env`.
+            #     * `tagValues:prod*` to find Google Cloud resources that have directly
+            #       attached tags where the
+            #       [`TagValue.namespacedName`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue)
+            #       contains a word prefixed by `prod`.
+            #     * `tagValueIds=tagValues/123` to find Google Cloud resources that have
+            #       directly attached tags where the
+            #       [`TagValue.name`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue)
+            #       is exactly `tagValues/123`.
+            #     * `effectiveTagKeys:env` to find Google Cloud resources that have
+            #       directly attached or inherited tags where the
+            #       [`TagKey.namespacedName`](https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey)
+            #       contains `env`.
+            #     * `effectiveTagValues:prod*` to find Google Cloud resources that have
+            #       directly attached or inherited tags where the
+            #       [`TagValue.namespacedName`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue)
+            #       contains a word prefixed by `prod`.
+            #     * `effectiveTagValueIds=tagValues/123` to find Google Cloud resources that
+            #        have directly attached or inherited tags where the
+            #       [`TagValue.name`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue)
+            #       is exactly `tagValues/123`.
             #     * `kmsKey:key` to find Google Cloud resources encrypted with a
-            #       customer-managed encryption key whose name contains "key" as a word. This
-            #       field is deprecated. Please use the `kmsKeys` field to retrieve Cloud KMS
+            #       customer-managed encryption key whose name contains `key` as a word. This
+            #       field is deprecated. Use the `kmsKeys` field to retrieve Cloud KMS
             #       key information.
             #     * `kmsKeys:key` to find Google Cloud resources encrypted with
-            #       customer-managed encryption keys whose name contains the word "key".
+            #       customer-managed encryption keys whose name contains the word `key`.
             #     * `relationships:instance-group-1` to find Google Cloud resources that have
-            #       relationships with "instance-group-1" in the related resource name.
+            #       relationships with `instance-group-1` in the related resource name.
             #     * `relationships:INSTANCE_TO_INSTANCEGROUP` to find Compute Engine
-            #       instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP".
+            #       instances that have relationships of type `INSTANCE_TO_INSTANCEGROUP`.
             #     * `relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1` to find
-            #       Compute Engine instances that have relationships with "instance-group-1"
+            #       Compute Engine instances that have relationships with `instance-group-1`
             #       in the Compute Engine instance group resource name, for relationship type
-            #       "INSTANCE_TO_INSTANCEGROUP".
+            #       `INSTANCE_TO_INSTANCEGROUP`.
+            #     * `sccSecurityMarks.key=value` to find Cloud resources that are attached
+            #       with security marks whose key is `key` and value is `value`.
+            #     * `sccSecurityMarks.key:*` to find Cloud resources that are attached with
+            #       security marks whose key is `key`.
             #     * `state:ACTIVE` to find Google Cloud resources whose state contains
-            #       "ACTIVE" as a word.
+            #       `ACTIVE` as a word.
             #     * `NOT state:ACTIVE` to find Google Cloud resources whose state doesn't
-            #       contain "ACTIVE" as a word.
+            #       contain `ACTIVE` as a word.
             #     * `createTime<1609459200` to find Google Cloud resources that were created
-            #       before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of
-            #       "2021-01-01 00:00:00 UTC" in seconds.
+            #       before `2021-01-01 00:00:00 UTC`. `1609459200` is the epoch timestamp of
+            #       `2021-01-01 00:00:00 UTC` in seconds.
             #     * `updateTime>1609459200` to find Google Cloud resources that were updated
-            #       after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of
-            #       "2021-01-01 00:00:00 UTC" in seconds.
-            #     * `Important` to find Google Cloud resources that contain "Important" as a
+            #       after `2021-01-01 00:00:00 UTC`. `1609459200` is the epoch timestamp of
+            #       `2021-01-01 00:00:00 UTC` in seconds.
+            #     * `Important` to find Google Cloud resources that contain `Important` as a
             #       word in any of the searchable fields.
-            #     * `Impor*` to find Google Cloud resources that contain "Impor" as a prefix
+            #     * `Impor*` to find Google Cloud resources that contain `Impor` as a prefix
             #       of any word in any of the searchable fields.
             #     * `Important location:(us-west1 OR global)` to find Google Cloud
-            #       resources that contain "Important" as a word in any of the searchable
-            #       fields and are also located in the "us-west1" region or the "global"
+            #       resources that contain `Important` as a word in any of the searchable
+            #       fields and are also located in the `us-west1` region or the `global`
             #       location.
             #   @param asset_types [::Array<::String>]
             #     Optional. A list of asset types that this request searches for. If empty,
             #     it will search all the [searchable asset
-            #     types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types).
+            #     types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
             #
             #     Regular expressions are also supported. For example:
             #
@@ -1235,10 +1263,10 @@ module Google
             #     supported asset type, an INVALID_ARGUMENT error will be returned.
             #   @param page_size [::Integer]
             #     Optional. The page size for search result pagination. Page size is capped
-            #     at 500 even if a larger value is given. If set to zero, server will pick an
-            #     appropriate default. Returned results may be fewer than requested. When
-            #     this happens, there could be more results as long as `next_page_token` is
-            #     returned.
+            #     at 500 even if a larger value is given. If set to zero or a negative value,
+            #     server will pick an appropriate default. Returned results may be fewer than
+            #     requested. When this happens, there could be more results as long as
+            #     `next_page_token` is returned.
             #   @param page_token [::String]
             #     Optional. If present, then retrieve the next batch of results from the
             #     preceding call to this method. `page_token` must be the value of
@@ -1249,7 +1277,7 @@ module Google
             #     the results. The default order is ascending. Add " DESC" after the field
             #     name to indicate descending order. Redundant space characters are ignored.
             #     Example: "location DESC, name".
-            #     Only singular primitive fields in the response are sortable:
+            #     Only the following fields in the response are sortable:
             #
             #       * name
             #       * assetType
@@ -1262,43 +1290,37 @@ module Google
             #       * state
             #       * parentFullResourceName
             #       * parentAssetType
-            #
-            #     All the other fields such as repeated fields (e.g., `networkTags`,
-            #     `kmsKeys`), map fields (e.g., `labels`) and struct fields (e.g.,
-            #     `additionalAttributes`) are not supported.
             #   @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
-            #     Optional. A comma-separated list of fields specifying which fields to be
-            #     returned in ResourceSearchResult. Only '*' or combination of top level
-            #     fields can be specified. Field names of both snake_case and camelCase are
-            #     supported. Examples: `"*"`, `"name,location"`, `"name,versionedResources"`.
-            #
-            #     The read_mask paths must be valid field paths listed but not limited to
-            #     (both snake_case and camelCase are supported):
-            #
-            #       * name
-            #       * assetType
-            #       * project
-            #       * displayName
-            #       * description
-            #       * location
-            #       * tagKeys
-            #       * tagValues
-            #       * tagValueIds
-            #       * labels
-            #       * networkTags
-            #       * kmsKey (This field is deprecated. Please use the `kmsKeys` field to
-            #         retrieve Cloud KMS key information.)
-            #       * kmsKeys
-            #       * createTime
-            #       * updateTime
-            #       * state
-            #       * additionalAttributes
-            #       * versionedResources
-            #
-            #     If read_mask is not specified, all fields except versionedResources will
-            #     be returned.
-            #     If only '*' is specified, all fields including versionedResources will be
-            #     returned.
+            #     Optional. A comma-separated list of fields that you want returned in the
+            #     results. The following fields are returned by default if not specified:
+            #
+            #       * `name`
+            #       * `assetType`
+            #       * `project`
+            #       * `folders`
+            #       * `organization`
+            #       * `displayName`
+            #       * `description`
+            #       * `location`
+            #       * `labels`
+            #       * `tags`
+            #       * `effectiveTags`
+            #       * `networkTags`
+            #       * `kmsKeys`
+            #       * `createTime`
+            #       * `updateTime`
+            #       * `state`
+            #       * `additionalAttributes`
+            #       * `parentFullResourceName`
+            #       * `parentAssetType`
+            #
+            #     Some fields of large size, such as `versionedResources`,
+            #     `attachedResources`, `effectiveTags` etc., are not returned by default, but
+            #     you can specify them in the `read_mask` parameter if you want to include
+            #     them. If `"*"` is specified, all [available
+            #     fields](https://cloud.google.com/asset-inventory/docs/reference/rest/v1/TopLevel/searchAllResources#resourcesearchresult)
+            #     are returned.
+            #     Examples: `"name,location"`, `"name,versionedResources"`, `"*"`.
             #     Any invalid field path will trigger INVALID_ARGUMENT error.
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -1449,10 +1471,10 @@ module Google
             #       principal type "user".
             #   @param page_size [::Integer]
             #     Optional. The page size for search result pagination. Page size is capped
-            #     at 500 even if a larger value is given. If set to zero, server will pick an
-            #     appropriate default. Returned results may be fewer than requested. When
-            #     this happens, there could be more results as long as `next_page_token` is
-            #     returned.
+            #     at 500 even if a larger value is given. If set to zero or a negative value,
+            #     server will pick an appropriate default. Returned results may be fewer than
+            #     requested. When this happens, there could be more results as long as
+            #     `next_page_token` is returned.
             #   @param page_token [::String]
             #     Optional. If present, retrieve the next batch of results from the preceding
             #     call to this method. `page_token` must be the value of `next_page_token`
@@ -1462,7 +1484,7 @@ module Google
             #     Optional. A list of asset types that the IAM policies are attached to. If
             #     empty, it will search the IAM policies that are attached to all the
             #     [searchable asset
-            #     types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types).
+            #     types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
             #
             #     Regular expressions are also supported. For example:
             #
@@ -1588,7 +1610,7 @@ module Google
             #     If both `analysis_query` and `saved_analysis_query` are provided, they
             #     will be merged together with the `saved_analysis_query` as base and
             #     the `analysis_query` as overrides. For more details of the merge behavior,
-            #     please refer to the
+            #     refer to the
             #     [MergeFrom](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.message#Message.MergeFrom.details)
             #     page.
             #
@@ -1711,7 +1733,7 @@ module Google
             #     If both `analysis_query` and `saved_analysis_query` are provided, they
             #     will be merged together with the `saved_analysis_query` as base and
             #     the `analysis_query` as overrides. For more details of the merge behavior,
-            #     please refer to the
+            #     refer to the
             #     [MergeFrom](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.message#Message.MergeFrom.details)
             #     doc.
             #
@@ -1897,8 +1919,7 @@ module Google
 
             ##
             # Issue a job that queries assets using a SQL statement compatible with
-            # [BigQuery Standard
-            # SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).
+            # [BigQuery SQL](https://cloud.google.com/bigquery/docs/introduction-sql).
             #
             # If the query execution finishes within timeout and there's no pagination,
             # the full query results will be returned in the `QueryAssetsResponse`.
@@ -1907,9 +1928,8 @@ module Google
             # with the `job_reference` from the a previous `QueryAssets` call.
             #
             # Note, the query result has approximately 10 GB limitation enforced by
-            # BigQuery
-            # https://cloud.google.com/bigquery/docs/best-practices-performance-output,
-            # queries return larger results will result in errors.
+            # [BigQuery](https://cloud.google.com/bigquery/docs/best-practices-performance-output).
+            # Queries return larger results will result in errors.
             #
             # @overload query_assets(request, options = nil)
             #   Pass arguments to `query_assets` via a request object, either of type
@@ -1934,8 +1954,8 @@ module Google
             #
             #     Only assets belonging to the `parent` will be returned.
             #   @param statement [::String]
-            #     Optional. A SQL statement that's compatible with [BigQuery Standard
-            #     SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).
+            #     Optional. A SQL statement that's compatible with [BigQuery
+            #     SQL](https://cloud.google.com/bigquery/docs/introduction-sql).
             #   @param job_reference [::String]
             #     Optional. Reference to the query job, which is from the
             #     `QueryAssetsResponse` of previous `QueryAssets` call.
@@ -2567,7 +2587,7 @@ module Google
             #     Required. The names refer to the [full_resource_names]
             #     (https://cloud.google.com/asset-inventory/docs/resource-name-format)
             #     of [searchable asset
-            #     types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types).
+            #     types](https://cloud.google.com/asset-inventory/docs/supported-asset-types).
             #     A maximum of 20 resources' effective policies can be retrieved in a batch.
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -2664,12 +2684,15 @@ module Google
             #   @param filter [::String]
             #     The expression to filter
             #     {::Google::Cloud::Asset::V1::AnalyzeOrgPoliciesResponse#org_policy_results AnalyzeOrgPoliciesResponse.org_policy_results}.
-            #     The only supported field is `consolidated_policy.attached_resource`, and
-            #     the only supported operator is `=`.
+            #     Filtering is currently available for bare literal values and the following
+            #     fields:
+            #     * consolidated_policy.attached_resource
+            #     * consolidated_policy.rules.enforce
             #
-            #     Example:
+            #     When filtering by a specific field, the only supported operator is `=`.
+            #     For example, filtering by
             #     consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001"
-            #     will return the org policy results of"folders/001".
+            #     will return all the Organization Policy results attached to "folders/001".
             #   @param page_size [::Integer]
             #     The maximum number of items to return per page. If unspecified,
             #     {::Google::Cloud::Asset::V1::AnalyzeOrgPoliciesResponse#org_policy_results AnalyzeOrgPoliciesResponse.org_policy_results}
@@ -2777,13 +2800,17 @@ module Google
             #     The analysis only contains organization policies for the provided
             #     constraint.
             #   @param filter [::String]
-            #     The expression to filter the governed containers in result.
-            #     The only supported field is `parent`, and the only supported operator is
-            #     `=`.
-            #
-            #     Example:
-            #     parent="//cloudresourcemanager.googleapis.com/folders/001" will return all
-            #     containers under "folders/001".
+            #     The expression to filter
+            #     {::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersResponse#governed_containers AnalyzeOrgPolicyGovernedContainersResponse.governed_containers}.
+            #     Filtering is currently available for bare literal values and the following
+            #     fields:
+            #     * parent
+            #     * consolidated_policy.rules.enforce
+            #
+            #     When filtering by a specific field, the only supported operator is `=`.
+            #     For example, filtering by
+            #     parent="//cloudresourcemanager.googleapis.com/folders/001"
+            #     will return all the containers under "folders/001".
             #   @param page_size [::Integer]
             #     The maximum number of items to return per page. If unspecified,
             #     {::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersResponse#governed_containers AnalyzeOrgPolicyGovernedContainersResponse.governed_containers}
@@ -2878,7 +2905,7 @@ module Google
             #
             # This RPC only returns either resources of types supported by [searchable
             # asset
-            # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types),
+            # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types),
             # or IAM policies.
             #
             # @overload analyze_org_policy_governed_assets(request, options = nil)
@@ -2908,18 +2935,33 @@ module Google
             #     analysis only contains analyzed organization policies for the provided
             #     constraint.
             #   @param filter [::String]
-            #     The expression to filter the governed assets in result. The only supported
-            #     fields for governed resources are `governed_resource.project` and
-            #     `governed_resource.folders`. The only supported fields for governed iam
-            #     policies are `governed_iam_policy.project` and
-            #     `governed_iam_policy.folders`. The only supported operator is `=`.
-            #
-            #     Example 1: governed_resource.project="projects/12345678" filter will return
-            #     all governed resources under projects/12345678 including the project
-            #     ifself, if applicable.
-            #
-            #     Example 2: governed_iam_policy.folders="folders/12345678" filter will
-            #     return all governed iam policies under folders/12345678, if applicable.
+            #     The expression to filter
+            #     {::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsResponse#governed_assets AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets}.
+            #
+            #     For governed resources, filtering is currently available for bare literal
+            #     values and the following fields:
+            #     * governed_resource.project
+            #     * governed_resource.folders
+            #     * consolidated_policy.rules.enforce
+            #     When filtering by `governed_resource.project` or
+            #     `consolidated_policy.rules.enforce`, the only supported operator is `=`.
+            #     When filtering by `governed_resource.folders`, the supported operators
+            #     are `=` and `:`.
+            #     For example, filtering by `governed_resource.project="projects/12345678"`
+            #     will return all the governed resources under "projects/12345678",
+            #     including the project itself if applicable.
+            #
+            #     For governed IAM policies, filtering is currently available for bare
+            #     literal values and the following fields:
+            #     * governed_iam_policy.project
+            #     * governed_iam_policy.folders
+            #     * consolidated_policy.rules.enforce
+            #     When filtering by `governed_iam_policy.project` or
+            #     `consolidated_policy.rules.enforce`, the only supported operator is `=`.
+            #     When filtering by `governed_iam_policy.folders`, the supported operators
+            #     are `=` and `:`.
+            #     For example, filtering by `governed_iam_policy.folders:"folders/12345678"`
+            #     will return all the governed IAM policies under "folders/001".
             #   @param page_size [::Integer]
             #     The maximum number of items to return per page. If unspecified,
             #     {::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsResponse#governed_assets AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets}