google-cloud-asset-v1 0.21.1 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -71,8 +71,7 @@ module Google
71
71
  # returned.
72
72
  # @!attribute [rw] output_config
73
73
  # @return [::Google::Cloud::Asset::V1::OutputConfig]
74
- # Required. Output configuration indicating where the results will be output
75
- # to.
74
+ # Required. Output configuration indicating where the results will be output to.
76
75
  # @!attribute [rw] relationship_types
77
76
  # @return [::Array<::String>]
78
77
  # A list of relationship types to export, for example:
@@ -96,10 +95,8 @@ module Google
96
95
  end
97
96
 
98
97
  # The export asset response. This message is returned by the
99
- # google.longrunning.Operations.GetOperation
100
- # method in the returned
101
- # {::Google::Longrunning::Operation#response google.longrunning.Operation.response}
102
- # field.
98
+ # google.longrunning.Operations.GetOperation method in the returned
99
+ # {::Google::Longrunning::Operation#response google.longrunning.Operation.response} field.
103
100
  # @!attribute [rw] read_time
104
101
  # @return [::Google::Protobuf::Timestamp]
105
102
  # Time the snapshot was taken.
@@ -121,11 +118,11 @@ module Google
121
118
  # ListAssets request.
122
119
  # @!attribute [rw] parent
123
120
  # @return [::String]
124
- # Required. Name of the organization, folder, or project the assets belong
125
- # to. Format: "organizations/[organization-number]" (such as
126
- # "organizations/123"), "projects/[project-id]" (such as
127
- # "projects/my-project-id"), "projects/[project-number]" (such as
128
- # "projects/12345"), or "folders/[folder-number]" (such as "folders/12345").
121
+ # Required. Name of the organization, folder, or project the assets belong to. Format:
122
+ # "organizations/[organization-number]" (such as "organizations/123"),
123
+ # "projects/[project-id]" (such as "projects/my-project-id"),
124
+ # "projects/[project-number]" (such as "projects/12345"), or
125
+ # "folders/[folder-number]" (such as "folders/12345").
129
126
  # @!attribute [rw] read_time
130
127
  # @return [::Google::Protobuf::Timestamp]
131
128
  # Timestamp to take an asset snapshot. This can only be set to a timestamp
@@ -278,8 +275,9 @@ module Google
278
275
  # be unique under a specific parent project/folder/organization.
279
276
  # @!attribute [rw] feed
280
277
  # @return [::Google::Cloud::Asset::V1::Feed]
281
- # Required. The feed details. The field `name` must be empty and it will be
282
- # generated in the format of: projects/project_number/feeds/feed_id
278
+ # Required. The feed details. The field `name` must be empty and it will be generated
279
+ # in the format of:
280
+ # projects/project_number/feeds/feed_id
283
281
  # folders/folder_number/feeds/feed_id
284
282
  # organizations/organization_number/feeds/feed_id
285
283
  class CreateFeedRequest
@@ -321,8 +319,8 @@ module Google
321
319
  # Update asset feed request.
322
320
  # @!attribute [rw] feed
323
321
  # @return [::Google::Cloud::Asset::V1::Feed]
324
- # Required. The new values of feed details. It must match an existing feed
325
- # and the field `name` must be in the format of:
322
+ # Required. The new values of feed details. It must match an existing feed and the
323
+ # field `name` must be in the format of:
326
324
  # projects/project_number/feeds/feed_id or
327
325
  # folders/folder_number/feeds/feed_id or
328
326
  # organizations/organization_number/feeds/feed_id.
@@ -613,9 +611,8 @@ module Google
613
611
  # Search all resources request.
614
612
  # @!attribute [rw] scope
615
613
  # @return [::String]
616
- # Required. A scope can be a project, a folder, or an organization. The
617
- # search is limited to the resources within the `scope`. The caller must be
618
- # granted the
614
+ # Required. A scope can be a project, a folder, or an organization. The search is
615
+ # limited to the resources within the `scope`. The caller must be granted the
619
616
  # [`cloudasset.assets.searchAllResources`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions)
620
617
  # permission on the desired scope.
621
618
  #
@@ -648,7 +645,11 @@ module Google
648
645
  # and its value is "prod".
649
646
  # * `labels.env:*` to find Cloud resources that have a label "env".
650
647
  # * `kmsKey:key` to find Cloud resources encrypted with a customer-managed
651
- # encryption key whose name contains the word "key".
648
+ # encryption key whose name contains "key" as a word. This field is
649
+ # deprecated. Please use the `kmsKeys` field to retrieve KMS key
650
+ # information.
651
+ # * `kmsKeys:key` to find Cloud resources encrypted with customer-managed
652
+ # encryption keys whose name contains the word "key".
652
653
  # * `relationships:instance-group-1` to find Cloud resources that have
653
654
  # relationships with "instance-group-1" in the related resource name.
654
655
  # * `relationships:INSTANCE_TO_INSTANCEGROUP` to find compute instances that
@@ -677,8 +678,8 @@ module Google
677
678
  # location.
678
679
  # @!attribute [rw] asset_types
679
680
  # @return [::Array<::String>]
680
- # Optional. A list of asset types that this request searches for. If empty,
681
- # it will search all the [searchable asset
681
+ # Optional. A list of asset types that this request searches for. If empty, it will
682
+ # search all the [searchable asset
682
683
  # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types).
683
684
  #
684
685
  # Regular expressions are also supported. For example:
@@ -693,22 +694,21 @@ module Google
693
694
  # supported asset type, an INVALID_ARGUMENT error will be returned.
694
695
  # @!attribute [rw] page_size
695
696
  # @return [::Integer]
696
- # Optional. The page size for search result pagination. Page size is capped
697
- # at 500 even if a larger value is given. If set to zero, server will pick an
698
- # appropriate default. Returned results may be fewer than requested. When
699
- # this happens, there could be more results as long as `next_page_token` is
700
- # returned.
697
+ # Optional. The page size for search result pagination. Page size is capped at 500 even
698
+ # if a larger value is given. If set to zero, server will pick an appropriate
699
+ # default. Returned results may be fewer than requested. When this happens,
700
+ # there could be more results as long as `next_page_token` is returned.
701
701
  # @!attribute [rw] page_token
702
702
  # @return [::String]
703
- # Optional. If present, then retrieve the next batch of results from the
704
- # preceding call to this method. `page_token` must be the value of
705
- # `next_page_token` from the previous response. The values of all other
706
- # method parameters, must be identical to those in the previous call.
703
+ # Optional. If present, then retrieve the next batch of results from the preceding call
704
+ # to this method. `page_token` must be the value of `next_page_token` from
705
+ # the previous response. The values of all other method parameters, must be
706
+ # identical to those in the previous call.
707
707
  # @!attribute [rw] order_by
708
708
  # @return [::String]
709
- # Optional. A comma-separated list of fields specifying the sorting order of
710
- # the results. The default order is ascending. Add " DESC" after the field
711
- # name to indicate descending order. Redundant space characters are ignored.
709
+ # Optional. A comma-separated list of fields specifying the sorting order of the
710
+ # results. The default order is ascending. Add " DESC" after the field name
711
+ # to indicate descending order. Redundant space characters are ignored.
712
712
  # Example: "location DESC, name".
713
713
  # Only singular primitive fields in the response are sortable:
714
714
  #
@@ -718,22 +718,21 @@ module Google
718
718
  # * displayName
719
719
  # * description
720
720
  # * location
721
- # * kmsKey
722
721
  # * createTime
723
722
  # * updateTime
724
723
  # * state
725
724
  # * parentFullResourceName
726
725
  # * parentAssetType
727
726
  #
728
- # All the other fields such as repeated fields (e.g., `networkTags`), map
729
- # fields (e.g., `labels`) and struct fields (e.g., `additionalAttributes`)
730
- # are not supported.
727
+ # All the other fields such as repeated fields (e.g., `networkTags`,
728
+ # `kmsKeys`), map fields (e.g., `labels`) and struct fields (e.g.,
729
+ # `additionalAttributes`) are not supported.
731
730
  # @!attribute [rw] read_mask
732
731
  # @return [::Google::Protobuf::FieldMask]
733
- # Optional. A comma-separated list of fields specifying which fields to be
734
- # returned in ResourceSearchResult. Only '*' or combination of top level
735
- # fields can be specified. Field names of both snake_case and camelCase are
736
- # supported. Examples: `"*"`, `"name,location"`, `"name,versionedResources"`.
732
+ # Optional. A comma-separated list of fields specifying which fields to be returned in
733
+ # ResourceSearchResult. Only '*' or combination of top level fields can be
734
+ # specified. Field names of both snake_case and camelCase are supported.
735
+ # Examples: `"*"`, `"name,location"`, `"name,versionedResources"`.
737
736
  #
738
737
  # The read_mask paths must be valid field paths listed but not limited to
739
738
  # (both snake_case and camelCase are supported):
@@ -749,7 +748,9 @@ module Google
749
748
  # * tagValueIds
750
749
  # * labels
751
750
  # * networkTags
752
- # * kmsKey
751
+ # * kmsKey (This field is deprecated. Please use the `kmsKeys` field to
752
+ # retrieve KMS key information.)
753
+ # * kmsKeys
753
754
  # * createTime
754
755
  # * updateTime
755
756
  # * state
@@ -784,9 +785,9 @@ module Google
784
785
  # Search all IAM policies request.
785
786
  # @!attribute [rw] scope
786
787
  # @return [::String]
787
- # Required. A scope can be a project, a folder, or an organization. The
788
- # search is limited to the IAM policies within the `scope`. The caller must
789
- # be granted the
788
+ # Required. A scope can be a project, a folder, or an organization. The search is
789
+ # limited to the IAM policies within the `scope`. The caller must be granted
790
+ # the
790
791
  # [`cloudasset.assets.searchAllIamPolicies`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions)
791
792
  # permission on the desired scope.
792
793
  #
@@ -842,22 +843,20 @@ module Google
842
843
  # principal type "user".
843
844
  # @!attribute [rw] page_size
844
845
  # @return [::Integer]
845
- # Optional. The page size for search result pagination. Page size is capped
846
- # at 500 even if a larger value is given. If set to zero, server will pick an
847
- # appropriate default. Returned results may be fewer than requested. When
848
- # this happens, there could be more results as long as `next_page_token` is
849
- # returned.
846
+ # Optional. The page size for search result pagination. Page size is capped at 500 even
847
+ # if a larger value is given. If set to zero, server will pick an appropriate
848
+ # default. Returned results may be fewer than requested. When this happens,
849
+ # there could be more results as long as `next_page_token` is returned.
850
850
  # @!attribute [rw] page_token
851
851
  # @return [::String]
852
- # Optional. If present, retrieve the next batch of results from the preceding
853
- # call to this method. `page_token` must be the value of `next_page_token`
854
- # from the previous response. The values of all other method parameters must
855
- # be identical to those in the previous call.
852
+ # Optional. If present, retrieve the next batch of results from the preceding call to
853
+ # this method. `page_token` must be the value of `next_page_token` from the
854
+ # previous response. The values of all other method parameters must be
855
+ # identical to those in the previous call.
856
856
  # @!attribute [rw] asset_types
857
857
  # @return [::Array<::String>]
858
- # Optional. A list of asset types that the IAM policies are attached to. If
859
- # empty, it will search the IAM policies that are attached to all the
860
- # [searchable asset
858
+ # Optional. A list of asset types that the IAM policies are attached to. If empty, it
859
+ # will search the IAM policies that are attached to all the [searchable asset
861
860
  # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types).
862
861
  #
863
862
  # Regular expressions are also supported. For example:
@@ -874,9 +873,9 @@ module Google
874
873
  # supported asset type, an INVALID_ARGUMENT error will be returned.
875
874
  # @!attribute [rw] order_by
876
875
  # @return [::String]
877
- # Optional. A comma-separated list of fields specifying the sorting order of
878
- # the results. The default order is ascending. Add " DESC" after the field
879
- # name to indicate descending order. Redundant space characters are ignored.
876
+ # Optional. A comma-separated list of fields specifying the sorting order of the
877
+ # results. The default order is ascending. Add " DESC" after the field name
878
+ # to indicate descending order. Redundant space characters are ignored.
880
879
  # Example: "assetType DESC, resource".
881
880
  # Only singular primitive fields in the response are sortable:
882
881
  # * resource
@@ -907,8 +906,8 @@ module Google
907
906
  # IAM policy analysis query message.
908
907
  # @!attribute [rw] scope
909
908
  # @return [::String]
910
- # Required. The relative name of the root asset. Only resources and IAM
911
- # policies within the scope will be analyzed.
909
+ # Required. The relative name of the root asset. Only resources and IAM policies within
910
+ # the scope will be analyzed.
912
911
  #
913
912
  # This can only be an organization number (such as "organizations/123"), a
914
913
  # folder number (such as "folders/123"), a project ID (such as
@@ -996,10 +995,9 @@ module Google
996
995
  # Optional. If true, the identities section of the result will expand any
997
996
  # Google groups appearing in an IAM policy binding.
998
997
  #
999
- # If
1000
- # {::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery#identity_selector IamPolicyAnalysisQuery.identity_selector}
1001
- # is specified, the identity in the result will be determined by the
1002
- # selector, and this flag is not allowed to set.
998
+ # If {::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery#identity_selector IamPolicyAnalysisQuery.identity_selector} is specified, the
999
+ # identity in the result will be determined by the selector, and this flag
1000
+ # is not allowed to set.
1003
1001
  #
1004
1002
  # If true, the default max expansion per group is 1000 for
1005
1003
  # AssetService.AnalyzeIamPolicy][].
@@ -1010,31 +1008,28 @@ module Google
1010
1008
  # Optional. If true, the access section of result will expand any roles
1011
1009
  # appearing in IAM policy bindings to include their permissions.
1012
1010
  #
1013
- # If
1014
- # {::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery#access_selector IamPolicyAnalysisQuery.access_selector}
1015
- # is specified, the access section of the result will be determined by the
1016
- # selector, and this flag is not allowed to set.
1011
+ # If {::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery#access_selector IamPolicyAnalysisQuery.access_selector} is specified, the access
1012
+ # section of the result will be determined by the selector, and this flag
1013
+ # is not allowed to set.
1017
1014
  #
1018
1015
  # Default is false.
1019
1016
  # @!attribute [rw] expand_resources
1020
1017
  # @return [::Boolean]
1021
- # Optional. If true and
1022
- # {::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery#resource_selector IamPolicyAnalysisQuery.resource_selector}
1023
- # is not specified, the resource section of the result will expand any
1024
- # resource attached to an IAM policy to include resources lower in the
1025
- # resource hierarchy.
1018
+ # Optional. If true and {::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery#resource_selector IamPolicyAnalysisQuery.resource_selector} is not
1019
+ # specified, the resource section of the result will expand any resource
1020
+ # attached to an IAM policy to include resources lower in the resource
1021
+ # hierarchy.
1026
1022
  #
1027
1023
  # For example, if the request analyzes for which resources user A has
1028
1024
  # permission P, and the results include an IAM policy with P on a GCP
1029
1025
  # folder, the results will also include resources in that folder with
1030
1026
  # permission P.
1031
1027
  #
1032
- # If true and
1033
- # {::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery#resource_selector IamPolicyAnalysisQuery.resource_selector}
1034
- # is specified, the resource section of the result will expand the
1035
- # specified resource to include resources lower in the resource hierarchy.
1036
- # Only project or lower resources are supported. Folder and organization
1037
- # resource cannot be used together with this option.
1028
+ # If true and {::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery#resource_selector IamPolicyAnalysisQuery.resource_selector} is specified,
1029
+ # the resource section of the result will expand the specified resource to
1030
+ # include resources lower in the resource hierarchy. Only project or
1031
+ # lower resources are supported. Folder and organization resource cannot be
1032
+ # used together with this option.
1038
1033
  #
1039
1034
  # For example, if the request analyzes for which users have permission P on
1040
1035
  # a GCP project with this option enabled, the results will include all
@@ -1047,21 +1042,21 @@ module Google
1047
1042
  # Default is false.
1048
1043
  # @!attribute [rw] output_resource_edges
1049
1044
  # @return [::Boolean]
1050
- # Optional. If true, the result will output the relevant parent/child
1051
- # relationships between resources. Default is false.
1045
+ # Optional. If true, the result will output the relevant parent/child relationships
1046
+ # between resources.
1047
+ # Default is false.
1052
1048
  # @!attribute [rw] output_group_edges
1053
1049
  # @return [::Boolean]
1054
- # Optional. If true, the result will output the relevant membership
1055
- # relationships between groups and other groups, and between groups and
1056
- # principals. Default is false.
1050
+ # Optional. If true, the result will output the relevant membership relationships
1051
+ # between groups and other groups, and between groups and principals.
1052
+ # Default is false.
1057
1053
  # @!attribute [rw] analyze_service_account_impersonation
1058
1054
  # @return [::Boolean]
1059
- # Optional. If true, the response will include access analysis from
1060
- # identities to resources via service account impersonation. This is a very
1061
- # expensive operation, because many derived queries will be executed. We
1062
- # highly recommend you use
1063
- # {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy_longrunning AssetService.AnalyzeIamPolicyLongrunning}
1064
- # rpc instead.
1055
+ # Optional. If true, the response will include access analysis from identities to
1056
+ # resources via service account impersonation. This is a very expensive
1057
+ # operation, because many derived queries will be executed. We highly
1058
+ # recommend you use {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy_longrunning AssetService.AnalyzeIamPolicyLongrunning} rpc
1059
+ # instead.
1065
1060
  #
1066
1061
  # For example, if the request analyzes for which resources user A has
1067
1062
  # permission P, and there's an IAM policy states user A has
@@ -1106,8 +1101,7 @@ module Google
1106
1101
  end
1107
1102
  end
1108
1103
 
1109
- # A request message for
1110
- # {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy AssetService.AnalyzeIamPolicy}.
1104
+ # A request message for {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy AssetService.AnalyzeIamPolicy}.
1111
1105
  # @!attribute [rw] analysis_query
1112
1106
  # @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery]
1113
1107
  # Required. The request query.
@@ -1131,8 +1125,7 @@ module Google
1131
1125
  # presence yet.
1132
1126
  # @!attribute [rw] execution_timeout
1133
1127
  # @return [::Google::Protobuf::Duration]
1134
- # Optional. Amount of time executable has to complete. See JSON
1135
- # representation of
1128
+ # Optional. Amount of time executable has to complete. See JSON representation of
1136
1129
  # [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json).
1137
1130
  #
1138
1131
  # If this field is set with a value less than the RPC deadline, and the
@@ -1147,8 +1140,7 @@ module Google
1147
1140
  extend ::Google::Protobuf::MessageExts::ClassMethods
1148
1141
  end
1149
1142
 
1150
- # A response message for
1151
- # {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy AssetService.AnalyzeIamPolicy}.
1143
+ # A response message for {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy AssetService.AnalyzeIamPolicy}.
1152
1144
  # @!attribute [rw] main_analysis
1153
1145
  # @return [::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse::IamPolicyAnalysis]
1154
1146
  # The main analysis that matches the original request.
@@ -1159,11 +1151,9 @@ module Google
1159
1151
  # enabled.
1160
1152
  # @!attribute [rw] fully_explored
1161
1153
  # @return [::Boolean]
1162
- # Represents whether all entries in the
1163
- # {::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse#main_analysis main_analysis}
1164
- # and
1165
- # {::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse#service_account_impersonation_analysis service_account_impersonation_analysis}
1166
- # have been fully explored to answer the query in the request.
1154
+ # Represents whether all entries in the {::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse#main_analysis main_analysis} and
1155
+ # {::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse#service_account_impersonation_analysis service_account_impersonation_analysis} have been fully explored to
1156
+ # answer the query in the request.
1167
1157
  class AnalyzeIamPolicyResponse
1168
1158
  include ::Google::Protobuf::MessageExts
1169
1159
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1174,14 +1164,12 @@ module Google
1174
1164
  # The analysis query.
1175
1165
  # @!attribute [rw] analysis_results
1176
1166
  # @return [::Array<::Google::Cloud::Asset::V1::IamPolicyAnalysisResult>]
1177
- # A list of
1178
- # {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult IamPolicyAnalysisResult}
1179
- # that matches the analysis query, or empty if no result is found.
1167
+ # A list of {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult IamPolicyAnalysisResult} that matches the analysis query, or
1168
+ # empty if no result is found.
1180
1169
  # @!attribute [rw] fully_explored
1181
1170
  # @return [::Boolean]
1182
- # Represents whether all entries in the
1183
- # {::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse::IamPolicyAnalysis#analysis_results analysis_results}
1184
- # have been fully explored to answer the query.
1171
+ # Represents whether all entries in the {::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse::IamPolicyAnalysis#analysis_results analysis_results} have been
1172
+ # fully explored to answer the query.
1185
1173
  # @!attribute [rw] non_critical_errors
1186
1174
  # @return [::Array<::Google::Cloud::Asset::V1::IamPolicyAnalysisState>]
1187
1175
  # A list of non-critical errors happened during the query handling.
@@ -1205,8 +1193,8 @@ module Google
1205
1193
  # A Cloud Storage location.
1206
1194
  # @!attribute [rw] uri
1207
1195
  # @return [::String]
1208
- # Required. The uri of the Cloud Storage object. It's the same uri that is
1209
- # used by gsutil. Example: "gs://bucket_name/object_name". See [Viewing and
1196
+ # Required. The uri of the Cloud Storage object. It's the same uri that is used by
1197
+ # gsutil. Example: "gs://bucket_name/object_name". See [Viewing and
1210
1198
  # Editing Object
1211
1199
  # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
1212
1200
  # for more information.
@@ -1222,15 +1210,13 @@ module Google
1222
1210
  # A BigQuery destination.
1223
1211
  # @!attribute [rw] dataset
1224
1212
  # @return [::String]
1225
- # Required. The BigQuery dataset in format
1226
- # "projects/projectId/datasets/datasetId", to which the analysis results
1227
- # should be exported. If this dataset does not exist, the export call will
1228
- # return an INVALID_ARGUMENT error.
1213
+ # Required. The BigQuery dataset in format "projects/projectId/datasets/datasetId",
1214
+ # to which the analysis results should be exported. If this dataset does
1215
+ # not exist, the export call will return an INVALID_ARGUMENT error.
1229
1216
  # @!attribute [rw] table_prefix
1230
1217
  # @return [::String]
1231
- # Required. The prefix of the BigQuery tables to which the analysis results
1232
- # will be written. Tables will be created based on this table_prefix if not
1233
- # exist:
1218
+ # Required. The prefix of the BigQuery tables to which the analysis results will be
1219
+ # written. Tables will be created based on this table_prefix if not exist:
1234
1220
  # * <table_prefix>_analysis table will contain export operation's metadata.
1235
1221
  # * <table_prefix>_analysis_result will contain all the
1236
1222
  # {::Google::Cloud::Asset::V1::IamPolicyAnalysisResult IamPolicyAnalysisResult}.
@@ -1241,8 +1227,8 @@ module Google
1241
1227
  # The partition key for BigQuery partitioned table.
1242
1228
  # @!attribute [rw] write_disposition
1243
1229
  # @return [::String]
1244
- # Optional. Specifies the action that occurs if the destination table or
1245
- # partition already exists. The following values are supported:
1230
+ # Optional. Specifies the action that occurs if the destination table or partition
1231
+ # already exists. The following values are supported:
1246
1232
  #
1247
1233
  # * WRITE_TRUNCATE: If the table or partition already exists, BigQuery
1248
1234
  # overwrites the entire table or all the partitions data.
@@ -1275,8 +1261,7 @@ module Google
1275
1261
  end
1276
1262
  end
1277
1263
 
1278
- # A request message for
1279
- # {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy_longrunning AssetService.AnalyzeIamPolicyLongrunning}.
1264
+ # A request message for {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy_longrunning AssetService.AnalyzeIamPolicyLongrunning}.
1280
1265
  # @!attribute [rw] analysis_query
1281
1266
  # @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery]
1282
1267
  # Required. The request query.
@@ -1300,15 +1285,13 @@ module Google
1300
1285
  # presence yet.
1301
1286
  # @!attribute [rw] output_config
1302
1287
  # @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig]
1303
- # Required. Output configuration indicating where the results will be output
1304
- # to.
1288
+ # Required. Output configuration indicating where the results will be output to.
1305
1289
  class AnalyzeIamPolicyLongrunningRequest
1306
1290
  include ::Google::Protobuf::MessageExts
1307
1291
  extend ::Google::Protobuf::MessageExts::ClassMethods
1308
1292
  end
1309
1293
 
1310
- # A response message for
1311
- # {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy_longrunning AssetService.AnalyzeIamPolicyLongrunning}.
1294
+ # A response message for {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy_longrunning AssetService.AnalyzeIamPolicyLongrunning}.
1312
1295
  class AnalyzeIamPolicyLongrunningResponse
1313
1296
  include ::Google::Protobuf::MessageExts
1314
1297
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1337,8 +1320,7 @@ module Google
1337
1320
  # Output only. The last update time of this saved query.
1338
1321
  # @!attribute [r] last_updater
1339
1322
  # @return [::String]
1340
- # Output only. The account's email address who has updated this saved query
1341
- # most recently.
1323
+ # Output only. The account's email address who has updated this saved query most recently.
1342
1324
  # @!attribute [rw] labels
1343
1325
  # @return [::Google::Protobuf::Map{::String => ::String}]
1344
1326
  # Labels applied on the resource.
@@ -1355,11 +1337,8 @@ module Google
1355
1337
  # @!attribute [rw] iam_policy_analysis_query
1356
1338
  # @return [::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery]
1357
1339
  # An IAM Policy Analysis query, which could be used in
1358
- # the
1359
- # {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy AssetService.AnalyzeIamPolicy}
1360
- # rpc or the
1361
- # {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy_longrunning AssetService.AnalyzeIamPolicyLongrunning}
1362
- # rpc.
1340
+ # the {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy AssetService.AnalyzeIamPolicy} rpc or
1341
+ # the {::Google::Cloud::Asset::V1::AssetService::Client#analyze_iam_policy_longrunning AssetService.AnalyzeIamPolicyLongrunning} rpc.
1363
1342
  class QueryContent
1364
1343
  include ::Google::Protobuf::MessageExts
1365
1344
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1378,20 +1357,20 @@ module Google
1378
1357
  # Request to create a saved query.
1379
1358
  # @!attribute [rw] parent
1380
1359
  # @return [::String]
1381
- # Required. The name of the project/folder/organization where this
1382
- # saved_query should be created in. It can only be an organization number
1383
- # (such as "organizations/123"), a folder number (such as "folders/123"), a
1384
- # project ID (such as "projects/my-project-id")", or a project number (such
1385
- # as "projects/12345").
1360
+ # Required. The name of the project/folder/organization where this saved_query
1361
+ # should be created in. It can only be an organization number (such as
1362
+ # "organizations/123"), a folder number (such as "folders/123"), a project ID
1363
+ # (such as "projects/my-project-id")", or a project number (such as
1364
+ # "projects/12345").
1386
1365
  # @!attribute [rw] saved_query
1387
1366
  # @return [::Google::Cloud::Asset::V1::SavedQuery]
1388
- # Required. The saved_query details. The `name` field must be empty as it
1389
- # will be generated based on the parent and saved_query_id.
1367
+ # Required. The saved_query details. The `name` field must be empty as it will be
1368
+ # generated based on the parent and saved_query_id.
1390
1369
  # @!attribute [rw] saved_query_id
1391
1370
  # @return [::String]
1392
- # Required. The ID to use for the saved query, which must be unique in the
1393
- # specified parent. It will become the final component of the saved query's
1394
- # resource name.
1371
+ # Required. The ID to use for the saved query, which must be unique in the specified
1372
+ # parent. It will become the final component of the saved query's resource
1373
+ # name.
1395
1374
  #
1396
1375
  # This value should be 4-63 characters, and valid characters
1397
1376
  # are /[a-z][0-9]-/.
@@ -1419,8 +1398,8 @@ module Google
1419
1398
  # Request to list saved queries.
1420
1399
  # @!attribute [rw] parent
1421
1400
  # @return [::String]
1422
- # Required. The parent project/folder/organization whose savedQueries are to
1423
- # be listed. It can only be using project/folder/organization number (such as
1401
+ # Required. The parent project/folder/organization whose savedQueries are to be
1402
+ # listed. It can only be using project/folder/organization number (such as
1424
1403
  # "folders/12345")", or a project ID (such as "projects/my-project-id").
1425
1404
  # @!attribute [rw] filter
1426
1405
  # @return [::String]
@@ -1433,9 +1412,8 @@ module Google
1433
1412
  # See https://google.aip.dev/160 for more information on the grammar.
1434
1413
  # @!attribute [rw] page_size
1435
1414
  # @return [::Integer]
1436
- # Optional. The maximum number of saved queries to return per page. The
1437
- # service may return fewer than this value. If unspecified, at most 50 will
1438
- # be returned.
1415
+ # Optional. The maximum number of saved queries to return per page. The service may
1416
+ # return fewer than this value. If unspecified, at most 50 will be returned.
1439
1417
  # The maximum value is 1000; values above 1000 will be coerced to 1000.
1440
1418
  # @!attribute [rw] page_token
1441
1419
  # @return [::String]
@@ -1484,8 +1462,7 @@ module Google
1484
1462
  # Request to delete a saved query.
1485
1463
  # @!attribute [rw] name
1486
1464
  # @return [::String]
1487
- # Required. The name of the saved query to delete. It must be in the format
1488
- # of:
1465
+ # Required. The name of the saved query to delete. It must be in the format of:
1489
1466
  #
1490
1467
  # * projects/project_number/savedQueries/saved_query_id
1491
1468
  # * folders/folder_number/savedQueries/saved_query_id
@@ -1594,13 +1571,12 @@ module Google
1594
1571
  # BigQuery destination.
1595
1572
  # @!attribute [rw] dataset
1596
1573
  # @return [::String]
1597
- # Required. The BigQuery dataset where the query results will be saved. It
1598
- # has the format of "projects/\\{projectId}/datasets/\\{datasetId}".
1574
+ # Required. The BigQuery dataset where the query results will be saved. It has the
1575
+ # format of "projects/\\{projectId}/datasets/\\{datasetId}".
1599
1576
  # @!attribute [rw] table
1600
1577
  # @return [::String]
1601
- # Required. The BigQuery table where the query results will be saved. If
1602
- # this table does not exist, a new table with the given name will be
1603
- # created.
1578
+ # Required. The BigQuery table where the query results will be saved. If this table
1579
+ # does not exist, a new table with the given name will be created.
1604
1580
  # @!attribute [rw] write_disposition
1605
1581
  # @return [::String]
1606
1582
  # Specifies the action that occurs if the destination table or partition
@@ -1610,8 +1586,10 @@ module Google
1610
1586
  # overwrites the entire table or all the partitions data.
1611
1587
  # * WRITE_APPEND: If the table or partition already exists, BigQuery
1612
1588
  # appends the data to the table or the latest partition.
1613
- # * WRITE_EMPTY: If the table already exists and contains data, an error is
1614
- # returned.
1589
+ # * WRITE_EMPTY: If the table already exists and contains data, a
1590
+ # 'duplicate' error is returned in the job result.
1591
+ #
1592
+ # The default value is WRITE_EMPTY.
1615
1593
  class BigQueryDestination
1616
1594
  include ::Google::Protobuf::MessageExts
1617
1595
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1633,12 +1611,12 @@ module Google
1633
1611
  # SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).
1634
1612
  # @!attribute [rw] job_reference
1635
1613
  # @return [::String]
1636
- # Optional. Reference to the query job, which is from the
1637
- # `QueryAssetsResponse` of previous `QueryAssets` call.
1614
+ # Optional. Reference to the query job, which is from the `QueryAssetsResponse` of
1615
+ # previous `QueryAssets` call.
1638
1616
  # @!attribute [rw] page_size
1639
1617
  # @return [::Integer]
1640
- # Optional. The maximum number of rows to return in the results. Responses
1641
- # are limited to 10 MB and 1000 rows.
1618
+ # Optional. The maximum number of rows to return in the results. Responses are limited
1619
+ # to 10 MB and 1000 rows.
1642
1620
  #
1643
1621
  # By default, the maximum row count is 1000. When the byte or row count limit
1644
1622
  # is reached, the rest of the query results will be paginated.
@@ -1651,11 +1629,10 @@ module Google
1651
1629
  # The field will be ignored when [output_config] is specified.
1652
1630
  # @!attribute [rw] timeout
1653
1631
  # @return [::Google::Protobuf::Duration]
1654
- # Optional. Specifies the maximum amount of time that the client is willing
1655
- # to wait for the query to complete. By default, this limit is 5 min for the
1656
- # first query, and 1 minute for the following queries. If the query is
1657
- # complete, the `done` field in the `QueryAssetsResponse` is true, otherwise
1658
- # false.
1632
+ # Optional. Specifies the maximum amount of time that the client is willing to wait
1633
+ # for the query to complete. By default, this limit is 5 min for the first
1634
+ # query, and 1 minute for the following queries. If the query is complete,
1635
+ # the `done` field in the `QueryAssetsResponse` is true, otherwise false.
1659
1636
  #
1660
1637
  # Like BigQuery [jobs.query
1661
1638
  # API](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#queryrequest)
@@ -1666,13 +1643,12 @@ module Google
1666
1643
  # The field will be ignored when [output_config] is specified.
1667
1644
  # @!attribute [rw] read_time_window
1668
1645
  # @return [::Google::Cloud::Asset::V1::TimeWindow]
1669
- # Optional. [start_time] is required. [start_time] must be less than
1670
- # [end_time] Defaults [end_time] to now if [start_time] is set and
1671
- # [end_time] isn't. Maximum permitted time range is 7 days.
1646
+ # Optional. [start_time] is required. [start_time] must be less than [end_time]
1647
+ # Defaults [end_time] to now if [start_time] is set and [end_time] isn't.
1648
+ # Maximum permitted time range is 7 days.
1672
1649
  # @!attribute [rw] read_time
1673
1650
  # @return [::Google::Protobuf::Timestamp]
1674
- # Optional. Queries cloud assets as they appeared at the specified point in
1675
- # time.
1651
+ # Optional. Queries cloud assets as they appeared at the specified point in time.
1676
1652
  # @!attribute [rw] output_config
1677
1653
  # @return [::Google::Cloud::Asset::V1::QueryAssetsOutputConfig]
1678
1654
  # Optional. Destination where the query results will be saved.
@@ -1783,8 +1759,7 @@ module Google
1783
1759
  extend ::Google::Protobuf::MessageExts::ClassMethods
1784
1760
  end
1785
1761
 
1786
- # A request message for
1787
- # {::Google::Cloud::Asset::V1::AssetService::Client#batch_get_effective_iam_policies AssetService.BatchGetEffectiveIamPolicies}.
1762
+ # A request message for {::Google::Cloud::Asset::V1::AssetService::Client#batch_get_effective_iam_policies AssetService.BatchGetEffectiveIamPolicies}.
1788
1763
  # @!attribute [rw] scope
1789
1764
  # @return [::String]
1790
1765
  # Required. Only IAM policies on or below the scope will be returned.
@@ -1810,16 +1785,14 @@ module Google
1810
1785
  extend ::Google::Protobuf::MessageExts::ClassMethods
1811
1786
  end
1812
1787
 
1813
- # A response message for
1814
- # {::Google::Cloud::Asset::V1::AssetService::Client#batch_get_effective_iam_policies AssetService.BatchGetEffectiveIamPolicies}.
1788
+ # A response message for {::Google::Cloud::Asset::V1::AssetService::Client#batch_get_effective_iam_policies AssetService.BatchGetEffectiveIamPolicies}.
1815
1789
  # @!attribute [rw] policy_results
1816
1790
  # @return [::Array<::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy>]
1817
1791
  # The effective policies for a batch of resources. Note that the results
1818
1792
  # order is the same as the order of
1819
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesRequest#names BatchGetEffectiveIamPoliciesRequest.names}.
1820
- # When a resource does not have any effective IAM policies, its corresponding
1821
- # policy_result will contain empty
1822
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#policies EffectiveIamPolicy.policies}.
1793
+ # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesRequest#names BatchGetEffectiveIamPoliciesRequest.names}. When a resource does not
1794
+ # have any effective IAM policies, its corresponding policy_result will
1795
+ # contain empty {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#policies EffectiveIamPolicy.policies}.
1823
1796
  class BatchGetEffectiveIamPoliciesResponse
1824
1797
  include ::Google::Protobuf::MessageExts
1825
1798
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1829,33 +1802,24 @@ module Google
1829
1802
  # @return [::String]
1830
1803
  # The [full_resource_name]
1831
1804
  # (https://cloud.google.com/asset-inventory/docs/resource-name-format)
1832
- # for which the
1833
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#policies policies}
1834
- # are computed. This is one of the
1835
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesRequest#names BatchGetEffectiveIamPoliciesRequest.names}
1836
- # the caller provides in the request.
1805
+ # for which the {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#policies policies} are computed. This is one of the
1806
+ # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesRequest#names BatchGetEffectiveIamPoliciesRequest.names} the caller provides in the
1807
+ # request.
1837
1808
  # @!attribute [rw] policies
1838
1809
  # @return [::Array<::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo>]
1839
- # The effective policies for the
1840
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#full_resource_name full_resource_name}.
1810
+ # The effective policies for the {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#full_resource_name full_resource_name}.
1841
1811
  #
1842
- # These policies include the policy set on the
1843
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#full_resource_name full_resource_name}
1844
- # and those set on its parents and ancestors up to the
1845
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesRequest#scope BatchGetEffectiveIamPoliciesRequest.scope}.
1846
- # Note that these policies are not filtered according to the resource type
1847
- # of the
1812
+ # These policies include the policy set on the {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#full_resource_name full_resource_name} and
1813
+ # those set on its parents and ancestors up to the
1814
+ # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesRequest#scope BatchGetEffectiveIamPoliciesRequest.scope}. Note that these policies
1815
+ # are not filtered according to the resource type of the
1848
1816
  # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#full_resource_name full_resource_name}.
1849
1817
  #
1850
1818
  # These policies are hierarchically ordered by
1851
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#attached_resource PolicyInfo.attached_resource}
1852
- # starting from
1853
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#full_resource_name full_resource_name}
1819
+ # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#attached_resource PolicyInfo.attached_resource} starting from {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy#full_resource_name full_resource_name}
1854
1820
  # itself to its parents and ancestors, such that policies[i]'s
1855
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#attached_resource PolicyInfo.attached_resource}
1856
- # is the child of policies[i+1]'s
1857
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#attached_resource PolicyInfo.attached_resource},
1858
- # if policies[i+1] exists.
1821
+ # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#attached_resource PolicyInfo.attached_resource} is the child of policies[i+1]'s
1822
+ # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#attached_resource PolicyInfo.attached_resource}, if policies[i+1] exists.
1859
1823
  class EffectiveIamPolicy
1860
1824
  include ::Google::Protobuf::MessageExts
1861
1825
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1863,13 +1827,10 @@ module Google
1863
1827
  # The IAM policy and its attached resource.
1864
1828
  # @!attribute [rw] attached_resource
1865
1829
  # @return [::String]
1866
- # The full resource name the
1867
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#policy policy}
1868
- # is directly attached to.
1830
+ # The full resource name the {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#policy policy} is directly attached to.
1869
1831
  # @!attribute [rw] policy
1870
1832
  # @return [::Google::Iam::V1::Policy]
1871
- # The IAM policy that's directly attached to the
1872
- # {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#attached_resource attached_resource}.
1833
+ # The IAM policy that's directly attached to the {::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse::EffectiveIamPolicy::PolicyInfo#attached_resource attached_resource}.
1873
1834
  class PolicyInfo
1874
1835
  include ::Google::Protobuf::MessageExts
1875
1836
  extend ::Google::Protobuf::MessageExts::ClassMethods