google-cloud-asset-v1 0.26.1 → 0.28.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.
@@ -327,6 +327,29 @@ module Google
327
327
  # @return [::Gapic::Operation]
328
328
  #
329
329
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
330
+ #
331
+ # @example Basic example
332
+ # require "google/cloud/asset/v1"
333
+ #
334
+ # # Create a client object. The client can be reused for multiple calls.
335
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
336
+ #
337
+ # # Create a request. To set request fields, pass in keyword arguments.
338
+ # request = Google::Cloud::Asset::V1::ExportAssetsRequest.new
339
+ #
340
+ # # Call the export_assets method.
341
+ # result = client.export_assets request
342
+ #
343
+ # # The returned object is of type Gapic::Operation. You can use it to
344
+ # # check the status of an operation, cancel it, or wait for results.
345
+ # # Here is how to wait for a response.
346
+ # result.wait_until_done! timeout: 60
347
+ # if result.response?
348
+ # p result.response
349
+ # else
350
+ # puts "No response received."
351
+ # end
352
+ #
330
353
  def export_assets request, options = nil
331
354
  raise ::ArgumentError, "request must be provided" if request.nil?
332
355
 
@@ -446,6 +469,26 @@ module Google
446
469
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Asset::V1::Asset>]
447
470
  #
448
471
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
472
+ #
473
+ # @example Basic example
474
+ # require "google/cloud/asset/v1"
475
+ #
476
+ # # Create a client object. The client can be reused for multiple calls.
477
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
478
+ #
479
+ # # Create a request. To set request fields, pass in keyword arguments.
480
+ # request = Google::Cloud::Asset::V1::ListAssetsRequest.new
481
+ #
482
+ # # Call the list_assets method.
483
+ # result = client.list_assets request
484
+ #
485
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
486
+ # # over elements, and API calls will be issued to fetch pages as needed.
487
+ # result.each do |item|
488
+ # # Each element is of type ::Google::Cloud::Asset::V1::Asset.
489
+ # p item
490
+ # end
491
+ #
449
492
  def list_assets request, options = nil
450
493
  raise ::ArgumentError, "request must be provided" if request.nil?
451
494
 
@@ -552,6 +595,22 @@ module Google
552
595
  # @return [::Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse]
553
596
  #
554
597
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
598
+ #
599
+ # @example Basic example
600
+ # require "google/cloud/asset/v1"
601
+ #
602
+ # # Create a client object. The client can be reused for multiple calls.
603
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
604
+ #
605
+ # # Create a request. To set request fields, pass in keyword arguments.
606
+ # request = Google::Cloud::Asset::V1::BatchGetAssetsHistoryRequest.new
607
+ #
608
+ # # Call the batch_get_assets_history method.
609
+ # result = client.batch_get_assets_history request
610
+ #
611
+ # # The returned object is of type Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse.
612
+ # p result
613
+ #
555
614
  def batch_get_assets_history request, options = nil
556
615
  raise ::ArgumentError, "request must be provided" if request.nil?
557
616
 
@@ -627,6 +686,22 @@ module Google
627
686
  # @return [::Google::Cloud::Asset::V1::Feed]
628
687
  #
629
688
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
689
+ #
690
+ # @example Basic example
691
+ # require "google/cloud/asset/v1"
692
+ #
693
+ # # Create a client object. The client can be reused for multiple calls.
694
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
695
+ #
696
+ # # Create a request. To set request fields, pass in keyword arguments.
697
+ # request = Google::Cloud::Asset::V1::CreateFeedRequest.new
698
+ #
699
+ # # Call the create_feed method.
700
+ # result = client.create_feed request
701
+ #
702
+ # # The returned object is of type Google::Cloud::Asset::V1::Feed.
703
+ # p result
704
+ #
630
705
  def create_feed request, options = nil
631
706
  raise ::ArgumentError, "request must be provided" if request.nil?
632
707
 
@@ -692,6 +767,22 @@ module Google
692
767
  # @return [::Google::Cloud::Asset::V1::Feed]
693
768
  #
694
769
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
770
+ #
771
+ # @example Basic example
772
+ # require "google/cloud/asset/v1"
773
+ #
774
+ # # Create a client object. The client can be reused for multiple calls.
775
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
776
+ #
777
+ # # Create a request. To set request fields, pass in keyword arguments.
778
+ # request = Google::Cloud::Asset::V1::GetFeedRequest.new
779
+ #
780
+ # # Call the get_feed method.
781
+ # result = client.get_feed request
782
+ #
783
+ # # The returned object is of type Google::Cloud::Asset::V1::Feed.
784
+ # p result
785
+ #
695
786
  def get_feed request, options = nil
696
787
  raise ::ArgumentError, "request must be provided" if request.nil?
697
788
 
@@ -756,6 +847,22 @@ module Google
756
847
  # @return [::Google::Cloud::Asset::V1::ListFeedsResponse]
757
848
  #
758
849
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
850
+ #
851
+ # @example Basic example
852
+ # require "google/cloud/asset/v1"
853
+ #
854
+ # # Create a client object. The client can be reused for multiple calls.
855
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
856
+ #
857
+ # # Create a request. To set request fields, pass in keyword arguments.
858
+ # request = Google::Cloud::Asset::V1::ListFeedsRequest.new
859
+ #
860
+ # # Call the list_feeds method.
861
+ # result = client.list_feeds request
862
+ #
863
+ # # The returned object is of type Google::Cloud::Asset::V1::ListFeedsResponse.
864
+ # p result
865
+ #
759
866
  def list_feeds request, options = nil
760
867
  raise ::ArgumentError, "request must be provided" if request.nil?
761
868
 
@@ -826,6 +933,22 @@ module Google
826
933
  # @return [::Google::Cloud::Asset::V1::Feed]
827
934
  #
828
935
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
936
+ #
937
+ # @example Basic example
938
+ # require "google/cloud/asset/v1"
939
+ #
940
+ # # Create a client object. The client can be reused for multiple calls.
941
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
942
+ #
943
+ # # Create a request. To set request fields, pass in keyword arguments.
944
+ # request = Google::Cloud::Asset::V1::UpdateFeedRequest.new
945
+ #
946
+ # # Call the update_feed method.
947
+ # result = client.update_feed request
948
+ #
949
+ # # The returned object is of type Google::Cloud::Asset::V1::Feed.
950
+ # p result
951
+ #
829
952
  def update_feed request, options = nil
830
953
  raise ::ArgumentError, "request must be provided" if request.nil?
831
954
 
@@ -891,6 +1014,22 @@ module Google
891
1014
  # @return [::Google::Protobuf::Empty]
892
1015
  #
893
1016
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1017
+ #
1018
+ # @example Basic example
1019
+ # require "google/cloud/asset/v1"
1020
+ #
1021
+ # # Create a client object. The client can be reused for multiple calls.
1022
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
1023
+ #
1024
+ # # Create a request. To set request fields, pass in keyword arguments.
1025
+ # request = Google::Cloud::Asset::V1::DeleteFeedRequest.new
1026
+ #
1027
+ # # Call the delete_feed method.
1028
+ # result = client.delete_feed request
1029
+ #
1030
+ # # The returned object is of type Google::Protobuf::Empty.
1031
+ # p result
1032
+ #
894
1033
  def delete_feed request, options = nil
895
1034
  raise ::ArgumentError, "request must be provided" if request.nil?
896
1035
 
@@ -969,49 +1108,73 @@ module Google
969
1108
  # Examples:
970
1109
  #
971
1110
  # * `name:Important` to find Google Cloud resources whose name contains
972
- # "Important" as a word.
1111
+ # `Important` as a word.
973
1112
  # * `name=Important` to find the Google Cloud resource whose name is exactly
974
- # "Important".
1113
+ # `Important`.
975
1114
  # * `displayName:Impor*` to find Google Cloud resources whose display name
976
- # contains "Impor" as a prefix of any word in the field.
1115
+ # contains `Impor` as a prefix of any word in the field.
977
1116
  # * `location:us-west*` to find Google Cloud resources whose location
978
- # contains both "us" and "west" as prefixes.
979
- # * `labels:prod` to find Google Cloud resources whose labels contain "prod"
1117
+ # contains both `us` and `west` as prefixes.
1118
+ # * `labels:prod` to find Google Cloud resources whose labels contain `prod`
980
1119
  # as a key or value.
981
- # * `labels.env:prod` to find Google Cloud resources that have a label "env"
982
- # and its value is "prod".
983
- # * `labels.env:*` to find Google Cloud resources that have a label "env".
1120
+ # * `labels.env:prod` to find Google Cloud resources that have a label `env`
1121
+ # and its value is `prod`.
1122
+ # * `labels.env:*` to find Google Cloud resources that have a label `env`.
1123
+ # * `tagKeys:env` to find Google Cloud resources that have directly
1124
+ # attached tags where the
1125
+ # [`TagKey`](https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey)
1126
+ # .`namespacedName` contains `env`.
1127
+ # * `tagValues:prod*` to find Google Cloud resources that have directly
1128
+ # attached tags where the
1129
+ # [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue)
1130
+ # .`namespacedName` contains a word prefixed by `prod`.
1131
+ # * `tagValueIds=tagValues/123` to find Google Cloud resources that have
1132
+ # directly attached tags where the
1133
+ # [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue)
1134
+ # .`name` is exactly `tagValues/123`.
1135
+ # * `effectiveTagKeys:env` to find Google Cloud resources that have
1136
+ # directly attached or inherited tags where the
1137
+ # [`TagKey`](https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey)
1138
+ # .`namespacedName` contains `env`.
1139
+ # * `effectiveTagValues:prod*` to find Google Cloud resources that have
1140
+ # directly attached or inherited tags where the
1141
+ # [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue)
1142
+ # .`namespacedName` contains a word prefixed by `prod`.
1143
+ # * `effectiveTagValueIds=tagValues/123` to find Google Cloud resources that
1144
+ # have directly attached or inherited tags where the
1145
+ # [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue)
1146
+ # .`name` is exactly `tagValues/123`.
984
1147
  # * `kmsKey:key` to find Google Cloud resources encrypted with a
985
- # customer-managed encryption key whose name contains "key" as a word. This
1148
+ # customer-managed encryption key whose name contains `key` as a word. This
986
1149
  # field is deprecated. Please use the `kmsKeys` field to retrieve Cloud KMS
987
1150
  # key information.
988
1151
  # * `kmsKeys:key` to find Google Cloud resources encrypted with
989
- # customer-managed encryption keys whose name contains the word "key".
1152
+ # customer-managed encryption keys whose name contains the word `key`.
990
1153
  # * `relationships:instance-group-1` to find Google Cloud resources that have
991
- # relationships with "instance-group-1" in the related resource name.
1154
+ # relationships with `instance-group-1` in the related resource name.
992
1155
  # * `relationships:INSTANCE_TO_INSTANCEGROUP` to find Compute Engine
993
- # instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP".
1156
+ # instances that have relationships of type `INSTANCE_TO_INSTANCEGROUP`.
994
1157
  # * `relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1` to find
995
- # Compute Engine instances that have relationships with "instance-group-1"
1158
+ # Compute Engine instances that have relationships with `instance-group-1`
996
1159
  # in the Compute Engine instance group resource name, for relationship type
997
- # "INSTANCE_TO_INSTANCEGROUP".
1160
+ # `INSTANCE_TO_INSTANCEGROUP`.
998
1161
  # * `state:ACTIVE` to find Google Cloud resources whose state contains
999
- # "ACTIVE" as a word.
1162
+ # `ACTIVE` as a word.
1000
1163
  # * `NOT state:ACTIVE` to find Google Cloud resources whose state doesn't
1001
- # contain "ACTIVE" as a word.
1164
+ # contain `ACTIVE` as a word.
1002
1165
  # * `createTime<1609459200` to find Google Cloud resources that were created
1003
- # before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of
1004
- # "2021-01-01 00:00:00 UTC" in seconds.
1166
+ # before `2021-01-01 00:00:00 UTC`. `1609459200` is the epoch timestamp of
1167
+ # `2021-01-01 00:00:00 UTC` in seconds.
1005
1168
  # * `updateTime>1609459200` to find Google Cloud resources that were updated
1006
- # after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of
1007
- # "2021-01-01 00:00:00 UTC" in seconds.
1008
- # * `Important` to find Google Cloud resources that contain "Important" as a
1169
+ # after `2021-01-01 00:00:00 UTC`. `1609459200` is the epoch timestamp of
1170
+ # `2021-01-01 00:00:00 UTC` in seconds.
1171
+ # * `Important` to find Google Cloud resources that contain `Important` as a
1009
1172
  # word in any of the searchable fields.
1010
- # * `Impor*` to find Google Cloud resources that contain "Impor" as a prefix
1173
+ # * `Impor*` to find Google Cloud resources that contain `Impor` as a prefix
1011
1174
  # of any word in any of the searchable fields.
1012
1175
  # * `Important location:(us-west1 OR global)` to find Google Cloud
1013
- # resources that contain "Important" as a word in any of the searchable
1014
- # fields and are also located in the "us-west1" region or the "global"
1176
+ # resources that contain `Important` as a word in any of the searchable
1177
+ # fields and are also located in the `us-west1` region or the `global`
1015
1178
  # location.
1016
1179
  # @param asset_types [::Array<::String>]
1017
1180
  # Optional. A list of asset types that this request searches for. If empty,
@@ -1030,10 +1193,10 @@ module Google
1030
1193
  # supported asset type, an INVALID_ARGUMENT error will be returned.
1031
1194
  # @param page_size [::Integer]
1032
1195
  # Optional. The page size for search result pagination. Page size is capped
1033
- # at 500 even if a larger value is given. If set to zero, server will pick an
1034
- # appropriate default. Returned results may be fewer than requested. When
1035
- # this happens, there could be more results as long as `next_page_token` is
1036
- # returned.
1196
+ # at 500 even if a larger value is given. If set to zero or a negative value,
1197
+ # server will pick an appropriate default. Returned results may be fewer than
1198
+ # requested. When this happens, there could be more results as long as
1199
+ # `next_page_token` is returned.
1037
1200
  # @param page_token [::String]
1038
1201
  # Optional. If present, then retrieve the next batch of results from the
1039
1202
  # preceding call to this method. `page_token` must be the value of
@@ -1044,7 +1207,7 @@ module Google
1044
1207
  # the results. The default order is ascending. Add " DESC" after the field
1045
1208
  # name to indicate descending order. Redundant space characters are ignored.
1046
1209
  # Example: "location DESC, name".
1047
- # Only singular primitive fields in the response are sortable:
1210
+ # Only the following fields in the response are sortable:
1048
1211
  #
1049
1212
  # * name
1050
1213
  # * assetType
@@ -1057,43 +1220,37 @@ module Google
1057
1220
  # * state
1058
1221
  # * parentFullResourceName
1059
1222
  # * parentAssetType
1060
- #
1061
- # All the other fields such as repeated fields (e.g., `networkTags`,
1062
- # `kmsKeys`), map fields (e.g., `labels`) and struct fields (e.g.,
1063
- # `additionalAttributes`) are not supported.
1064
1223
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
1065
- # Optional. A comma-separated list of fields specifying which fields to be
1066
- # returned in ResourceSearchResult. Only '*' or combination of top level
1067
- # fields can be specified. Field names of both snake_case and camelCase are
1068
- # supported. Examples: `"*"`, `"name,location"`, `"name,versionedResources"`.
1069
- #
1070
- # The read_mask paths must be valid field paths listed but not limited to
1071
- # (both snake_case and camelCase are supported):
1072
- #
1073
- # * name
1074
- # * assetType
1075
- # * project
1076
- # * displayName
1077
- # * description
1078
- # * location
1079
- # * tagKeys
1080
- # * tagValues
1081
- # * tagValueIds
1082
- # * labels
1083
- # * networkTags
1084
- # * kmsKey (This field is deprecated. Please use the `kmsKeys` field to
1085
- # retrieve Cloud KMS key information.)
1086
- # * kmsKeys
1087
- # * createTime
1088
- # * updateTime
1089
- # * state
1090
- # * additionalAttributes
1091
- # * versionedResources
1092
- #
1093
- # If read_mask is not specified, all fields except versionedResources will
1094
- # be returned.
1095
- # If only '*' is specified, all fields including versionedResources will be
1096
- # returned.
1224
+ # Optional. A comma-separated list of fields that you want returned in the
1225
+ # results. The following fields are returned by default if not specified:
1226
+ #
1227
+ # * `name`
1228
+ # * `assetType`
1229
+ # * `project`
1230
+ # * `folders`
1231
+ # * `organization`
1232
+ # * `displayName`
1233
+ # * `description`
1234
+ # * `location`
1235
+ # * `labels`
1236
+ # * `tags`
1237
+ # * `effectiveTags`
1238
+ # * `networkTags`
1239
+ # * `kmsKeys`
1240
+ # * `createTime`
1241
+ # * `updateTime`
1242
+ # * `state`
1243
+ # * `additionalAttributes`
1244
+ # * `parentFullResourceName`
1245
+ # * `parentAssetType`
1246
+ #
1247
+ # Some fields of large size, such as `versionedResources`,
1248
+ # `attachedResources`, `effectiveTags` etc., are not returned by default, but
1249
+ # you can specify them in the `read_mask` parameter if you want to include
1250
+ # them. If `"*"` is specified, all [available
1251
+ # fields](https://cloud.google.com/asset-inventory/docs/reference/rest/v1/TopLevel/searchAllResources#resourcesearchresult)
1252
+ # are returned.
1253
+ # Examples: `"name,location"`, `"name,versionedResources"`, `"*"`.
1097
1254
  # Any invalid field path will trigger INVALID_ARGUMENT error.
1098
1255
  # @yield [result, operation] Access the result along with the TransportOperation object
1099
1256
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Asset::V1::ResourceSearchResult>]
@@ -1102,6 +1259,26 @@ module Google
1102
1259
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Asset::V1::ResourceSearchResult>]
1103
1260
  #
1104
1261
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1262
+ #
1263
+ # @example Basic example
1264
+ # require "google/cloud/asset/v1"
1265
+ #
1266
+ # # Create a client object. The client can be reused for multiple calls.
1267
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
1268
+ #
1269
+ # # Create a request. To set request fields, pass in keyword arguments.
1270
+ # request = Google::Cloud::Asset::V1::SearchAllResourcesRequest.new
1271
+ #
1272
+ # # Call the search_all_resources method.
1273
+ # result = client.search_all_resources request
1274
+ #
1275
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1276
+ # # over elements, and API calls will be issued to fetch pages as needed.
1277
+ # result.each do |item|
1278
+ # # Each element is of type ::Google::Cloud::Asset::V1::ResourceSearchResult.
1279
+ # p item
1280
+ # end
1281
+ #
1105
1282
  def search_all_resources request, options = nil
1106
1283
  raise ::ArgumentError, "request must be provided" if request.nil?
1107
1284
 
@@ -1217,10 +1394,10 @@ module Google
1217
1394
  # principal type "user".
1218
1395
  # @param page_size [::Integer]
1219
1396
  # Optional. The page size for search result pagination. Page size is capped
1220
- # at 500 even if a larger value is given. If set to zero, server will pick an
1221
- # appropriate default. Returned results may be fewer than requested. When
1222
- # this happens, there could be more results as long as `next_page_token` is
1223
- # returned.
1397
+ # at 500 even if a larger value is given. If set to zero or a negative value,
1398
+ # server will pick an appropriate default. Returned results may be fewer than
1399
+ # requested. When this happens, there could be more results as long as
1400
+ # `next_page_token` is returned.
1224
1401
  # @param page_token [::String]
1225
1402
  # Optional. If present, retrieve the next batch of results from the preceding
1226
1403
  # call to this method. `page_token` must be the value of `next_page_token`
@@ -1262,6 +1439,26 @@ module Google
1262
1439
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Asset::V1::IamPolicySearchResult>]
1263
1440
  #
1264
1441
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1442
+ #
1443
+ # @example Basic example
1444
+ # require "google/cloud/asset/v1"
1445
+ #
1446
+ # # Create a client object. The client can be reused for multiple calls.
1447
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
1448
+ #
1449
+ # # Create a request. To set request fields, pass in keyword arguments.
1450
+ # request = Google::Cloud::Asset::V1::SearchAllIamPoliciesRequest.new
1451
+ #
1452
+ # # Call the search_all_iam_policies method.
1453
+ # result = client.search_all_iam_policies request
1454
+ #
1455
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1456
+ # # over elements, and API calls will be issued to fetch pages as needed.
1457
+ # result.each do |item|
1458
+ # # Each element is of type ::Google::Cloud::Asset::V1::IamPolicySearchResult.
1459
+ # p item
1460
+ # end
1461
+ #
1265
1462
  def search_all_iam_policies request, options = nil
1266
1463
  raise ::ArgumentError, "request must be provided" if request.nil?
1267
1464
 
@@ -1355,6 +1552,22 @@ module Google
1355
1552
  # @return [::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse]
1356
1553
  #
1357
1554
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1555
+ #
1556
+ # @example Basic example
1557
+ # require "google/cloud/asset/v1"
1558
+ #
1559
+ # # Create a client object. The client can be reused for multiple calls.
1560
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
1561
+ #
1562
+ # # Create a request. To set request fields, pass in keyword arguments.
1563
+ # request = Google::Cloud::Asset::V1::AnalyzeIamPolicyRequest.new
1564
+ #
1565
+ # # Call the analyze_iam_policy method.
1566
+ # result = client.analyze_iam_policy request
1567
+ #
1568
+ # # The returned object is of type Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse.
1569
+ # p result
1570
+ #
1358
1571
  def analyze_iam_policy request, options = nil
1359
1572
  raise ::ArgumentError, "request must be provided" if request.nil?
1360
1573
 
@@ -1446,6 +1659,29 @@ module Google
1446
1659
  # @return [::Gapic::Operation]
1447
1660
  #
1448
1661
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1662
+ #
1663
+ # @example Basic example
1664
+ # require "google/cloud/asset/v1"
1665
+ #
1666
+ # # Create a client object. The client can be reused for multiple calls.
1667
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
1668
+ #
1669
+ # # Create a request. To set request fields, pass in keyword arguments.
1670
+ # request = Google::Cloud::Asset::V1::AnalyzeIamPolicyLongrunningRequest.new
1671
+ #
1672
+ # # Call the analyze_iam_policy_longrunning method.
1673
+ # result = client.analyze_iam_policy_longrunning request
1674
+ #
1675
+ # # The returned object is of type Gapic::Operation. You can use it to
1676
+ # # check the status of an operation, cancel it, or wait for results.
1677
+ # # Here is how to wait for a response.
1678
+ # result.wait_until_done! timeout: 60
1679
+ # if result.response?
1680
+ # p result.response
1681
+ # else
1682
+ # puts "No response received."
1683
+ # end
1684
+ #
1449
1685
  def analyze_iam_policy_longrunning request, options = nil
1450
1686
  raise ::ArgumentError, "request must be provided" if request.nil?
1451
1687
 
@@ -1525,6 +1761,22 @@ module Google
1525
1761
  # @return [::Google::Cloud::Asset::V1::AnalyzeMoveResponse]
1526
1762
  #
1527
1763
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1764
+ #
1765
+ # @example Basic example
1766
+ # require "google/cloud/asset/v1"
1767
+ #
1768
+ # # Create a client object. The client can be reused for multiple calls.
1769
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
1770
+ #
1771
+ # # Create a request. To set request fields, pass in keyword arguments.
1772
+ # request = Google::Cloud::Asset::V1::AnalyzeMoveRequest.new
1773
+ #
1774
+ # # Call the analyze_move method.
1775
+ # result = client.analyze_move request
1776
+ #
1777
+ # # The returned object is of type Google::Cloud::Asset::V1::AnalyzeMoveResponse.
1778
+ # p result
1779
+ #
1528
1780
  def analyze_move request, options = nil
1529
1781
  raise ::ArgumentError, "request must be provided" if request.nil?
1530
1782
 
@@ -1562,8 +1814,7 @@ module Google
1562
1814
 
1563
1815
  ##
1564
1816
  # Issue a job that queries assets using a SQL statement compatible with
1565
- # [BigQuery Standard
1566
- # SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).
1817
+ # [BigQuery SQL](https://cloud.google.com/bigquery/docs/introduction-sql).
1567
1818
  #
1568
1819
  # If the query execution finishes within timeout and there's no pagination,
1569
1820
  # the full query results will be returned in the `QueryAssetsResponse`.
@@ -1572,9 +1823,8 @@ module Google
1572
1823
  # with the `job_reference` from the a previous `QueryAssets` call.
1573
1824
  #
1574
1825
  # Note, the query result has approximately 10 GB limitation enforced by
1575
- # BigQuery
1576
- # https://cloud.google.com/bigquery/docs/best-practices-performance-output,
1577
- # queries return larger results will result in errors.
1826
+ # [BigQuery](https://cloud.google.com/bigquery/docs/best-practices-performance-output).
1827
+ # Queries return larger results will result in errors.
1578
1828
  #
1579
1829
  # @overload query_assets(request, options = nil)
1580
1830
  # Pass arguments to `query_assets` via a request object, either of type
@@ -1599,8 +1849,8 @@ module Google
1599
1849
  #
1600
1850
  # Only assets belonging to the `parent` will be returned.
1601
1851
  # @param statement [::String]
1602
- # Optional. A SQL statement that's compatible with [BigQuery Standard
1603
- # SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).
1852
+ # Optional. A SQL statement that's compatible with [BigQuery
1853
+ # SQL](https://cloud.google.com/bigquery/docs/introduction-sql).
1604
1854
  # @param job_reference [::String]
1605
1855
  # Optional. Reference to the query job, which is from the
1606
1856
  # `QueryAssetsResponse` of previous `QueryAssets` call.
@@ -1654,6 +1904,22 @@ module Google
1654
1904
  # @return [::Google::Cloud::Asset::V1::QueryAssetsResponse]
1655
1905
  #
1656
1906
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1907
+ #
1908
+ # @example Basic example
1909
+ # require "google/cloud/asset/v1"
1910
+ #
1911
+ # # Create a client object. The client can be reused for multiple calls.
1912
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
1913
+ #
1914
+ # # Create a request. To set request fields, pass in keyword arguments.
1915
+ # request = Google::Cloud::Asset::V1::QueryAssetsRequest.new
1916
+ #
1917
+ # # Call the query_assets method.
1918
+ # result = client.query_assets request
1919
+ #
1920
+ # # The returned object is of type Google::Cloud::Asset::V1::QueryAssetsResponse.
1921
+ # p result
1922
+ #
1657
1923
  def query_assets request, options = nil
1658
1924
  raise ::ArgumentError, "request must be provided" if request.nil?
1659
1925
 
@@ -1733,6 +1999,22 @@ module Google
1733
1999
  # @return [::Google::Cloud::Asset::V1::SavedQuery]
1734
2000
  #
1735
2001
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2002
+ #
2003
+ # @example Basic example
2004
+ # require "google/cloud/asset/v1"
2005
+ #
2006
+ # # Create a client object. The client can be reused for multiple calls.
2007
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
2008
+ #
2009
+ # # Create a request. To set request fields, pass in keyword arguments.
2010
+ # request = Google::Cloud::Asset::V1::CreateSavedQueryRequest.new
2011
+ #
2012
+ # # Call the create_saved_query method.
2013
+ # result = client.create_saved_query request
2014
+ #
2015
+ # # The returned object is of type Google::Cloud::Asset::V1::SavedQuery.
2016
+ # p result
2017
+ #
1736
2018
  def create_saved_query request, options = nil
1737
2019
  raise ::ArgumentError, "request must be provided" if request.nil?
1738
2020
 
@@ -1799,6 +2081,22 @@ module Google
1799
2081
  # @return [::Google::Cloud::Asset::V1::SavedQuery]
1800
2082
  #
1801
2083
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2084
+ #
2085
+ # @example Basic example
2086
+ # require "google/cloud/asset/v1"
2087
+ #
2088
+ # # Create a client object. The client can be reused for multiple calls.
2089
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
2090
+ #
2091
+ # # Create a request. To set request fields, pass in keyword arguments.
2092
+ # request = Google::Cloud::Asset::V1::GetSavedQueryRequest.new
2093
+ #
2094
+ # # Call the get_saved_query method.
2095
+ # result = client.get_saved_query request
2096
+ #
2097
+ # # The returned object is of type Google::Cloud::Asset::V1::SavedQuery.
2098
+ # p result
2099
+ #
1802
2100
  def get_saved_query request, options = nil
1803
2101
  raise ::ArgumentError, "request must be provided" if request.nil?
1804
2102
 
@@ -1882,6 +2180,26 @@ module Google
1882
2180
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Asset::V1::SavedQuery>]
1883
2181
  #
1884
2182
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2183
+ #
2184
+ # @example Basic example
2185
+ # require "google/cloud/asset/v1"
2186
+ #
2187
+ # # Create a client object. The client can be reused for multiple calls.
2188
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
2189
+ #
2190
+ # # Create a request. To set request fields, pass in keyword arguments.
2191
+ # request = Google::Cloud::Asset::V1::ListSavedQueriesRequest.new
2192
+ #
2193
+ # # Call the list_saved_queries method.
2194
+ # result = client.list_saved_queries request
2195
+ #
2196
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2197
+ # # over elements, and API calls will be issued to fetch pages as needed.
2198
+ # result.each do |item|
2199
+ # # Each element is of type ::Google::Cloud::Asset::V1::SavedQuery.
2200
+ # p item
2201
+ # end
2202
+ #
1885
2203
  def list_saved_queries request, options = nil
1886
2204
  raise ::ArgumentError, "request must be provided" if request.nil?
1887
2205
 
@@ -1954,6 +2272,22 @@ module Google
1954
2272
  # @return [::Google::Cloud::Asset::V1::SavedQuery]
1955
2273
  #
1956
2274
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2275
+ #
2276
+ # @example Basic example
2277
+ # require "google/cloud/asset/v1"
2278
+ #
2279
+ # # Create a client object. The client can be reused for multiple calls.
2280
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
2281
+ #
2282
+ # # Create a request. To set request fields, pass in keyword arguments.
2283
+ # request = Google::Cloud::Asset::V1::UpdateSavedQueryRequest.new
2284
+ #
2285
+ # # Call the update_saved_query method.
2286
+ # result = client.update_saved_query request
2287
+ #
2288
+ # # The returned object is of type Google::Cloud::Asset::V1::SavedQuery.
2289
+ # p result
2290
+ #
1957
2291
  def update_saved_query request, options = nil
1958
2292
  raise ::ArgumentError, "request must be provided" if request.nil?
1959
2293
 
@@ -2021,6 +2355,22 @@ module Google
2021
2355
  # @return [::Google::Protobuf::Empty]
2022
2356
  #
2023
2357
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2358
+ #
2359
+ # @example Basic example
2360
+ # require "google/cloud/asset/v1"
2361
+ #
2362
+ # # Create a client object. The client can be reused for multiple calls.
2363
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
2364
+ #
2365
+ # # Create a request. To set request fields, pass in keyword arguments.
2366
+ # request = Google::Cloud::Asset::V1::DeleteSavedQueryRequest.new
2367
+ #
2368
+ # # Call the delete_saved_query method.
2369
+ # result = client.delete_saved_query request
2370
+ #
2371
+ # # The returned object is of type Google::Protobuf::Empty.
2372
+ # p result
2373
+ #
2024
2374
  def delete_saved_query request, options = nil
2025
2375
  raise ::ArgumentError, "request must be provided" if request.nil?
2026
2376
 
@@ -2099,6 +2449,22 @@ module Google
2099
2449
  # @return [::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse]
2100
2450
  #
2101
2451
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2452
+ #
2453
+ # @example Basic example
2454
+ # require "google/cloud/asset/v1"
2455
+ #
2456
+ # # Create a client object. The client can be reused for multiple calls.
2457
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
2458
+ #
2459
+ # # Create a request. To set request fields, pass in keyword arguments.
2460
+ # request = Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesRequest.new
2461
+ #
2462
+ # # Call the batch_get_effective_iam_policies method.
2463
+ # result = client.batch_get_effective_iam_policies request
2464
+ #
2465
+ # # The returned object is of type Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse.
2466
+ # p result
2467
+ #
2102
2468
  def batch_get_effective_iam_policies request, options = nil
2103
2469
  raise ::ArgumentError, "request must be provided" if request.nil?
2104
2470
 
@@ -2183,6 +2549,26 @@ module Google
2183
2549
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPoliciesResponse::OrgPolicyResult>]
2184
2550
  #
2185
2551
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2552
+ #
2553
+ # @example Basic example
2554
+ # require "google/cloud/asset/v1"
2555
+ #
2556
+ # # Create a client object. The client can be reused for multiple calls.
2557
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
2558
+ #
2559
+ # # Create a request. To set request fields, pass in keyword arguments.
2560
+ # request = Google::Cloud::Asset::V1::AnalyzeOrgPoliciesRequest.new
2561
+ #
2562
+ # # Call the analyze_org_policies method.
2563
+ # result = client.analyze_org_policies request
2564
+ #
2565
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2566
+ # # over elements, and API calls will be issued to fetch pages as needed.
2567
+ # result.each do |item|
2568
+ # # Each element is of type ::Google::Cloud::Asset::V1::AnalyzeOrgPoliciesResponse::OrgPolicyResult.
2569
+ # p item
2570
+ # end
2571
+ #
2186
2572
  def analyze_org_policies request, options = nil
2187
2573
  raise ::ArgumentError, "request must be provided" if request.nil?
2188
2574
 
@@ -2270,6 +2656,26 @@ module Google
2270
2656
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersResponse::GovernedContainer>]
2271
2657
  #
2272
2658
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2659
+ #
2660
+ # @example Basic example
2661
+ # require "google/cloud/asset/v1"
2662
+ #
2663
+ # # Create a client object. The client can be reused for multiple calls.
2664
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
2665
+ #
2666
+ # # Create a request. To set request fields, pass in keyword arguments.
2667
+ # request = Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersRequest.new
2668
+ #
2669
+ # # Call the analyze_org_policy_governed_containers method.
2670
+ # result = client.analyze_org_policy_governed_containers request
2671
+ #
2672
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2673
+ # # over elements, and API calls will be issued to fetch pages as needed.
2674
+ # result.each do |item|
2675
+ # # Each element is of type ::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersResponse::GovernedContainer.
2676
+ # p item
2677
+ # end
2678
+ #
2273
2679
  def analyze_org_policy_governed_containers request, options = nil
2274
2680
  raise ::ArgumentError, "request must be provided" if request.nil?
2275
2681
 
@@ -2379,6 +2785,26 @@ module Google
2379
2785
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsResponse::GovernedAsset>]
2380
2786
  #
2381
2787
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2788
+ #
2789
+ # @example Basic example
2790
+ # require "google/cloud/asset/v1"
2791
+ #
2792
+ # # Create a client object. The client can be reused for multiple calls.
2793
+ # client = Google::Cloud::Asset::V1::AssetService::Rest::Client.new
2794
+ #
2795
+ # # Create a request. To set request fields, pass in keyword arguments.
2796
+ # request = Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsRequest.new
2797
+ #
2798
+ # # Call the analyze_org_policy_governed_assets method.
2799
+ # result = client.analyze_org_policy_governed_assets request
2800
+ #
2801
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2802
+ # # over elements, and API calls will be issued to fetch pages as needed.
2803
+ # result.each do |item|
2804
+ # # Each element is of type ::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsResponse::GovernedAsset.
2805
+ # p item
2806
+ # end
2807
+ #
2382
2808
  def analyze_org_policy_governed_assets request, options = nil
2383
2809
  raise ::ArgumentError, "request must be provided" if request.nil?
2384
2810