google-cloud-channel-v1 2.3.0 → 2.4.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: 880bf6bb7d758fb7dfe29ce7c3418875681f4fa11a548f874ff3aa3297c77bbe
4
- data.tar.gz: 5f9b3f645e1d257aeb52f2d911e39b69878ef9f653581c4589e6726990985427
3
+ metadata.gz: cf6b2d2b001d3503382dc4dacafb395429d5dfb493fd9e2bd28c10abe25df77c
4
+ data.tar.gz: 22c460bf39d48ba08b28df5fd5a4f2d256d2c98c8afa485a72a6d4430850f143
5
5
  SHA512:
6
- metadata.gz: 62416e345c11a9bdbf4e0630eb746f1b23f095dbf18da2073cdf00a0212c4a907d633defea299f192b2d1f34fa584dd6aaaca9838219bda300a9e8f50b998a5b
7
- data.tar.gz: d6a5bf4c042c43c96874c16486e1e3906314344f3c37d15a5c6dc1af561ea4b0506f53f9c6a1dbac78141ef74e69858038f0b33c115cce44dfd05dfaee16bfdb
6
+ metadata.gz: 0b1e14fcb4d6ea7b2318767474d4f89ed17469de381f33afa171ca852b123b572d463b705103177b96c908e69a60d59881f3b2cd23cdae896d4a5e00c6118a0e
7
+ data.tar.gz: 201a55f0a17673858f35d82fdc97cf5919169c9f9858d83939aca3099503b1fc8619ac4624ca5dd37fa549c7b803b42dbfe02e21418ee27c84aa9efe705ea419
@@ -620,8 +620,6 @@ module Google
620
620
  # @return [::String,nil]
621
621
  # @!attribute [rw] credentials
622
622
  # Credentials to send with calls. You may provide any of the following types:
623
- # * (`String`) The path to a service account key file in JSON format
624
- # * (`Hash`) A service account key as a Hash
625
623
  # * (`Google::Auth::Credentials`) A googleauth credentials object
626
624
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
627
625
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -630,7 +628,26 @@ module Google
630
628
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
631
629
  # * (`nil`) indicating no credentials
632
630
  #
633
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
631
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
632
+ # is deprecated. Providing an unvalidated credential configuration to
633
+ # Google APIs can compromise the security of your systems and data.
634
+ #
635
+ # @example
636
+ #
637
+ # # The recommended way to provide credentials is to use the `make_creds` method
638
+ # # on the appropriate credentials class for your environment.
639
+ #
640
+ # require "googleauth"
641
+ #
642
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
643
+ # json_key_io: ::File.open("/path/to/keyfile.json")
644
+ # )
645
+ #
646
+ # client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new do |config|
647
+ # config.credentials = credentials
648
+ # end
649
+ #
650
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
634
651
  # external source for authentication to Google Cloud, you must validate it before
635
652
  # providing it to a Google API client library. Providing an unvalidated credential
636
653
  # 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]
@@ -6124,8 +6124,6 @@ module Google
6124
6124
  # @return [::String,nil]
6125
6125
  # @!attribute [rw] credentials
6126
6126
  # Credentials to send with calls. You may provide any of the following types:
6127
- # * (`String`) The path to a service account key file in JSON format
6128
- # * (`Hash`) A service account key as a Hash
6129
6127
  # * (`Google::Auth::Credentials`) A googleauth credentials object
6130
6128
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
6131
6129
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -6134,7 +6132,26 @@ module Google
6134
6132
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
6135
6133
  # * (`nil`) indicating no credentials
6136
6134
  #
6137
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
6135
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
6136
+ # is deprecated. Providing an unvalidated credential configuration to
6137
+ # Google APIs can compromise the security of your systems and data.
6138
+ #
6139
+ # @example
6140
+ #
6141
+ # # The recommended way to provide credentials is to use the `make_creds` method
6142
+ # # on the appropriate credentials class for your environment.
6143
+ #
6144
+ # require "googleauth"
6145
+ #
6146
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
6147
+ # json_key_io: ::File.open("/path/to/keyfile.json")
6148
+ # )
6149
+ #
6150
+ # client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new do |config|
6151
+ # config.credentials = credentials
6152
+ # end
6153
+ #
6154
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
6138
6155
  # external source for authentication to Google Cloud, you must validate it before
6139
6156
  # providing it to a Google API client library. Providing an unvalidated credential
6140
6157
  # 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 Channel
23
23
  module V1
24
- VERSION = "2.3.0"
24
+ VERSION = "2.4.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-channel-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.3.0
4
+ version: 2.4.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC