google-cloud-policy_simulator-v1 1.5.0 → 1.6.1

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 99b7c1b3a75456f7ea573a4985b359ba28c1ddb274778dbd08699c9bc63745e1
4
- data.tar.gz: a14bfb121cbd001ffe24946e4c04b061165a2d50a6d51ebb9584828eacfa2f08
3
+ metadata.gz: 1349249b8d368f23719a306004d59820797e8d37e01ddc703c9ad1e83bd74146
4
+ data.tar.gz: 06e1e5ecf49ce3f8e34aedc02248f4a7a2327dbe0cbaa0d4d1b513032a7c2725
5
5
  SHA512:
6
- metadata.gz: dc21f85a8107d60763b4d86b4690315ac195ec0dde79d02fdb606f2b0f2f0603749d337f877147b84e6b7bcc49fcf4234f4fd519eb7617ac9d2afd5e9986acec
7
- data.tar.gz: '080c368cb9abf3c542686f8f87301056a4b57b66ba85e6975f4e45ece9f494f943008ad203d6fc670bc23f948407cf07afa6bbfd7975c93daabe3e219cdd60b6'
6
+ metadata.gz: a14290817addc54d1fc824cde94222668c8193ae559f2e5cfc99b72b15608f9dc3d478b0649213735164c5714fecc96af7d2843577d61e5be6732de9d12257a9
7
+ data.tar.gz: 2393ab61c01206ae201dbccbd55f1b6ac7ed5ec75fbc977061a7ee6e6698f1e7665867e43bcf62b6bfdac8bb2e1b74e6d4e2004a99dc9e302bf3b8547037a771
@@ -673,8 +673,6 @@ module Google
673
673
  # @return [::String,nil]
674
674
  # @!attribute [rw] credentials
675
675
  # Credentials to send with calls. You may provide any of the following types:
676
- # * (`String`) The path to a service account key file in JSON format
677
- # * (`Hash`) A service account key as a Hash
678
676
  # * (`Google::Auth::Credentials`) A googleauth credentials object
679
677
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
680
678
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -683,7 +681,26 @@ module Google
683
681
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
684
682
  # * (`nil`) indicating no credentials
685
683
  #
686
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
684
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
685
+ # is deprecated. Providing an unvalidated credential configuration to
686
+ # Google APIs can compromise the security of your systems and data.
687
+ #
688
+ # @example
689
+ #
690
+ # # The recommended way to provide credentials is to use the `make_creds` method
691
+ # # on the appropriate credentials class for your environment.
692
+ #
693
+ # require "googleauth"
694
+ #
695
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
696
+ # json_key_io: ::File.open("/path/to/keyfile.json")
697
+ # )
698
+ #
699
+ # client = ::Google::Cloud::PolicySimulator::V1::OrgPolicyViolationsPreviewService::Client.new do |config|
700
+ # config.credentials = credentials
701
+ # end
702
+ #
703
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
687
704
  # external source for authentication to Google Cloud, you must validate it before
688
705
  # providing it to a Google API client library. Providing an unvalidated credential
689
706
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -134,7 +134,7 @@ module Google
134
134
  # @param options [::Gapic::CallOptions, ::Hash]
135
135
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
136
136
  #
137
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
137
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
138
138
  # Pass arguments to `list_operations` via keyword arguments. Note that at
139
139
  # least one keyword argument is required. To specify no parameters, or to keep all
140
140
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -147,6 +147,17 @@ module Google
147
147
  # The standard list page size.
148
148
  # @param page_token [::String]
149
149
  # The standard list page token.
150
+ # @param return_partial_success [::Boolean]
151
+ # When set to `true`, operations that are reachable are returned as normal,
152
+ # and those that are unreachable are returned in the
153
+ # [ListOperationsResponse.unreachable] field.
154
+ #
155
+ # This can only be `true` when reading across collections e.g. when `parent`
156
+ # is set to `"projects/example/locations/-"`.
157
+ #
158
+ # This field is not by default supported and will result in an
159
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
160
+ # service or product specific documentation.
150
161
  #
151
162
  # @yield [response, operation] Access the result along with the RPC operation
152
163
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -631,8 +642,6 @@ module Google
631
642
  # @return [::String,nil]
632
643
  # @!attribute [rw] credentials
633
644
  # Credentials to send with calls. You may provide any of the following types:
634
- # * (`String`) The path to a service account key file in JSON format
635
- # * (`Hash`) A service account key as a Hash
636
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
637
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
638
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -641,7 +650,26 @@ module Google
641
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
642
651
  # * (`nil`) indicating no credentials
643
652
  #
644
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
653
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
654
+ # is deprecated. Providing an unvalidated credential configuration to
655
+ # Google APIs can compromise the security of your systems and data.
656
+ #
657
+ # @example
658
+ #
659
+ # # The recommended way to provide credentials is to use the `make_creds` method
660
+ # # on the appropriate credentials class for your environment.
661
+ #
662
+ # require "googleauth"
663
+ #
664
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
665
+ # json_key_io: ::File.open("/path/to/keyfile.json")
666
+ # )
667
+ #
668
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
669
+ # config.credentials = credentials
670
+ # end
671
+ #
672
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
645
673
  # external source for authentication to Google Cloud, you must validate it before
646
674
  # providing it to a Google API client library. Providing an unvalidated credential
647
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -125,7 +125,7 @@ module Google
125
125
  # @param options [::Gapic::CallOptions, ::Hash]
126
126
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
127
127
  #
128
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
128
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
129
129
  # Pass arguments to `list_operations` via keyword arguments. Note that at
130
130
  # least one keyword argument is required. To specify no parameters, or to keep all
131
131
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -138,6 +138,17 @@ module Google
138
138
  # The standard list page size.
139
139
  # @param page_token [::String]
140
140
  # The standard list page token.
141
+ # @param return_partial_success [::Boolean]
142
+ # When set to `true`, operations that are reachable are returned as normal,
143
+ # and those that are unreachable are returned in the
144
+ # [ListOperationsResponse.unreachable] field.
145
+ #
146
+ # This can only be `true` when reading across collections e.g. when `parent`
147
+ # is set to `"projects/example/locations/-"`.
148
+ #
149
+ # This field is not by default supported and will result in an
150
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
151
+ # service or product specific documentation.
141
152
  # @yield [result, operation] Access the result along with the TransportOperation object
142
153
  # @yieldparam result [::Gapic::Operation]
143
154
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -563,8 +563,6 @@ module Google
563
563
  # @return [::String,nil]
564
564
  # @!attribute [rw] credentials
565
565
  # Credentials to send with calls. You may provide any of the following types:
566
- # * (`String`) The path to a service account key file in JSON format
567
- # * (`Hash`) A service account key as a Hash
568
566
  # * (`Google::Auth::Credentials`) A googleauth credentials object
569
567
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
570
568
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -573,7 +571,26 @@ module Google
573
571
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
574
572
  # * (`nil`) indicating no credentials
575
573
  #
576
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
574
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
575
+ # is deprecated. Providing an unvalidated credential configuration to
576
+ # Google APIs can compromise the security of your systems and data.
577
+ #
578
+ # @example
579
+ #
580
+ # # The recommended way to provide credentials is to use the `make_creds` method
581
+ # # on the appropriate credentials class for your environment.
582
+ #
583
+ # require "googleauth"
584
+ #
585
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
586
+ # json_key_io: ::File.open("/path/to/keyfile.json")
587
+ # )
588
+ #
589
+ # client = ::Google::Cloud::PolicySimulator::V1::Simulator::Client.new do |config|
590
+ # config.credentials = credentials
591
+ # end
592
+ #
593
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
577
594
  # external source for authentication to Google Cloud, you must validate it before
578
595
  # providing it to a Google API client library. Providing an unvalidated credential
579
596
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -134,7 +134,7 @@ module Google
134
134
  # @param options [::Gapic::CallOptions, ::Hash]
135
135
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
136
136
  #
137
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
137
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
138
138
  # Pass arguments to `list_operations` via keyword arguments. Note that at
139
139
  # least one keyword argument is required. To specify no parameters, or to keep all
140
140
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -147,6 +147,17 @@ module Google
147
147
  # The standard list page size.
148
148
  # @param page_token [::String]
149
149
  # The standard list page token.
150
+ # @param return_partial_success [::Boolean]
151
+ # When set to `true`, operations that are reachable are returned as normal,
152
+ # and those that are unreachable are returned in the
153
+ # [ListOperationsResponse.unreachable] field.
154
+ #
155
+ # This can only be `true` when reading across collections e.g. when `parent`
156
+ # is set to `"projects/example/locations/-"`.
157
+ #
158
+ # This field is not by default supported and will result in an
159
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
160
+ # service or product specific documentation.
150
161
  #
151
162
  # @yield [response, operation] Access the result along with the RPC operation
152
163
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -631,8 +642,6 @@ module Google
631
642
  # @return [::String,nil]
632
643
  # @!attribute [rw] credentials
633
644
  # Credentials to send with calls. You may provide any of the following types:
634
- # * (`String`) The path to a service account key file in JSON format
635
- # * (`Hash`) A service account key as a Hash
636
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
637
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
638
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -641,7 +650,26 @@ module Google
641
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
642
651
  # * (`nil`) indicating no credentials
643
652
  #
644
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
653
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
654
+ # is deprecated. Providing an unvalidated credential configuration to
655
+ # Google APIs can compromise the security of your systems and data.
656
+ #
657
+ # @example
658
+ #
659
+ # # The recommended way to provide credentials is to use the `make_creds` method
660
+ # # on the appropriate credentials class for your environment.
661
+ #
662
+ # require "googleauth"
663
+ #
664
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
665
+ # json_key_io: ::File.open("/path/to/keyfile.json")
666
+ # )
667
+ #
668
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
669
+ # config.credentials = credentials
670
+ # end
671
+ #
672
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
645
673
  # external source for authentication to Google Cloud, you must validate it before
646
674
  # providing it to a Google API client library. Providing an unvalidated credential
647
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -125,7 +125,7 @@ module Google
125
125
  # @param options [::Gapic::CallOptions, ::Hash]
126
126
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
127
127
  #
128
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
128
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
129
129
  # Pass arguments to `list_operations` via keyword arguments. Note that at
130
130
  # least one keyword argument is required. To specify no parameters, or to keep all
131
131
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -138,6 +138,17 @@ module Google
138
138
  # The standard list page size.
139
139
  # @param page_token [::String]
140
140
  # The standard list page token.
141
+ # @param return_partial_success [::Boolean]
142
+ # When set to `true`, operations that are reachable are returned as normal,
143
+ # and those that are unreachable are returned in the
144
+ # [ListOperationsResponse.unreachable] field.
145
+ #
146
+ # This can only be `true` when reading across collections e.g. when `parent`
147
+ # is set to `"projects/example/locations/-"`.
148
+ #
149
+ # This field is not by default supported and will result in an
150
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
151
+ # service or product specific documentation.
141
152
  # @yield [result, operation] Access the result along with the TransportOperation object
142
153
  # @yieldparam result [::Gapic::Operation]
143
154
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module PolicySimulator
23
23
  module V1
24
- VERSION = "1.5.0"
24
+ VERSION = "1.6.1"
25
25
  end
26
26
  end
27
27
  end
@@ -83,6 +83,18 @@ module Google
83
83
  # @!attribute [rw] page_token
84
84
  # @return [::String]
85
85
  # The standard list page token.
86
+ # @!attribute [rw] return_partial_success
87
+ # @return [::Boolean]
88
+ # When set to `true`, operations that are reachable are returned as normal,
89
+ # and those that are unreachable are returned in the
90
+ # [ListOperationsResponse.unreachable] field.
91
+ #
92
+ # This can only be `true` when reading across collections e.g. when `parent`
93
+ # is set to `"projects/example/locations/-"`.
94
+ #
95
+ # This field is not by default supported and will result in an
96
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
97
+ # service or product specific documentation.
86
98
  class ListOperationsRequest
87
99
  include ::Google::Protobuf::MessageExts
88
100
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -96,6 +108,12 @@ module Google
96
108
  # @!attribute [rw] next_page_token
97
109
  # @return [::String]
98
110
  # The standard List next-page token.
111
+ # @!attribute [rw] unreachable
112
+ # @return [::Array<::String>]
113
+ # Unordered list. Unreachable resources. Populated when the request sets
114
+ # `ListOperationsRequest.return_partial_success` and reads across
115
+ # collections e.g. when attempting to list all resources across all supported
116
+ # locations.
99
117
  class ListOperationsResponse
100
118
  include ::Google::Protobuf::MessageExts
101
119
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-policy_simulator-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.5.0
4
+ version: 1.6.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC