google-cloud-service_directory-v1beta1 0.6.0 → 0.7.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (20) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +8 -8
  3. data/README.md +1 -1
  4. data/lib/google/cloud/service_directory/v1beta1/lookup_service/client.rb +63 -56
  5. data/lib/google/cloud/service_directory/v1beta1/registration_service/client.rb +205 -141
  6. data/lib/google/cloud/service_directory/v1beta1/registration_service/paths.rb +17 -0
  7. data/lib/google/cloud/service_directory/v1beta1/version.rb +1 -1
  8. data/lib/google/cloud/servicedirectory/v1beta1/endpoint_pb.rb +4 -0
  9. data/lib/google/cloud/servicedirectory/v1beta1/namespace_pb.rb +3 -0
  10. data/lib/google/cloud/servicedirectory/v1beta1/registration_service_services_pb.rb +6 -6
  11. data/lib/google/cloud/servicedirectory/v1beta1/service_pb.rb +3 -0
  12. data/proto_docs/google/api/field_behavior.rb +7 -1
  13. data/proto_docs/google/cloud/servicedirectory/v1beta1/endpoint.rb +48 -12
  14. data/proto_docs/google/cloud/servicedirectory/v1beta1/lookup_service.rb +29 -14
  15. data/proto_docs/google/cloud/servicedirectory/v1beta1/namespace.rb +9 -3
  16. data/proto_docs/google/cloud/servicedirectory/v1beta1/registration_service.rb +115 -77
  17. data/proto_docs/google/cloud/servicedirectory/v1beta1/service.rb +35 -6
  18. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  19. data/proto_docs/google/type/expr.rb +35 -12
  20. metadata +16 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 32ce8dff1a14a8030b196030a767a8ee8755e4244945c465b5256ff19444e9d3
4
- data.tar.gz: 132cb35fc6328818878a7c02a78bbd6f14e51ea18c2d684a97eab56b3fd3dc89
3
+ metadata.gz: 70ab0cfcafe400def5b567105502bb2e63648502f3f1cdb6d2af24d8e1e8939c
4
+ data.tar.gz: 74fc52eab7bb8ad708c1998d6c1bcfdb84c2c10a271eef717652b09288552c2a
5
5
  SHA512:
6
- metadata.gz: 83f6720baf539b407e4396cd64897e1e70027b5226ac3dca8da1273aa69edffde5120857768de1340164bcdcb9f8e2ec3b2e35fcaacf031e6ad06d377097cfcf
7
- data.tar.gz: 798cb864c9d03672cc301334bdba51ed4272b2a59ca1b2b1189728f523198d5850ffe3134f20ff8bffaa7bea1840fc7388dc932763dc50258d7e8792a3537d01
6
+ metadata.gz: 275360801dd674154ef6239cdd804f30f6a6c82eb711828430e1f3c0e4893e2116725a2f4d957ea37da0c0082a2b110dcbca063c9f7bffcafb160125b045d733
7
+ data.tar.gz: 194b06dd93f23188e89c119597b126bbafe39887e3855ac9360d79cfcff53561e77840dd3bd1c82be0e8eeb8227692880769309d66ce6101ac4524d4ad3cccf7
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-service_directory-v1beta1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Credentials}):
68
68
 
69
- 1. `SERVICE_DIRECTORY_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `SERVICE_DIRECTORY_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `SERVICE_DIRECTORY_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `SERVICE_DIRECTORY_KEYFILE` - Path to JSON file, or JSON contents
71
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
74
74
 
75
75
  ```ruby
76
76
  require "google/cloud/service_directory/v1beta1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
82
82
 
83
83
  ### Configuration
84
84
 
85
- The **Credentials JSON** can be configured instead of placing them in
86
- environment variables. Either on an individual client initialization:
85
+ The path to the **Credentials JSON** file can be configured instead of storing
86
+ it in an environment variable. Either on an individual client initialization:
87
87
 
88
88
  ```ruby
89
89
  require "google/cloud/service_directory/v1beta1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new d
93
93
  end
94
94
  ```
95
95
 
96
- Or configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/service_directory/v1beta1"
data/README.md CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/service_directory/v1beta1"
34
34
 
35
35
  client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest.new # (request fields as keyword arguments...)
37
37
  response = client.resolve_service request
38
38
  ```
39
39
 
data/lib/google/cloud/service_directory/v1beta1/lookup_service/client.rb CHANGED
@@ -41,13 +41,12 @@ module Google
41
41
  # See {::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client::Configuration}
42
42
  # for a description of the configuration fields.
43
43
  #
44
- # ## Example
44
+ # @example
45
45
  #
46
- # To modify the configuration for all LookupService clients:
47
- #
48
- # ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
49
- # config.timeout = 10.0
50
- # end
46
+ # # Modify the configuration for all LookupService clients
47
+ # ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
48
+ # config.timeout = 10.0
49
+ # end
51
50
  #
52
51
  # @yield [config] Configure the Client client.
53
52
  # @yieldparam config [Client::Configuration]
@@ -67,10 +66,7 @@ module Google
67
66
 
68
67
  default_config.timeout = 15.0
69
68
  default_config.retry_policy = {
70
- initial_delay: 1.0,
71
- max_delay: 60.0,
72
- multiplier: 1.3,
73
- retry_codes: [14, 2]
69
+ initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
74
70
  }
75
71
 
76
72
  default_config
@@ -102,19 +98,15 @@ module Google
102
98
  ##
103
99
  # Create a new LookupService client object.
104
100
  #
105
- # ## Examples
106
- #
107
- # To create a new LookupService client with the default
108
- # configuration:
109
- #
110
- # client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
101
+ # @example
111
102
  #
112
- # To create a new LookupService client with a custom
113
- # configuration:
103
+ # # Create a client using the default configuration
104
+ # client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
114
105
  #
115
- # client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
116
- # config.timeout = 10.0
117
- # end
106
+ # # Create a client using a custom configuration
107
+ # client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
108
+ # config.timeout = 10.0
109
+ # end
118
110
  #
119
111
  # @yield [config] Configure the LookupService client.
120
112
  # @yieldparam config [Client::Configuration]
@@ -134,14 +126,13 @@ module Google
134
126
 
135
127
  # Create credentials
136
128
  credentials = @config.credentials
137
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
129
+ # Use self-signed JWT if the endpoint is unchanged from default,
138
130
  # but only if the default endpoint does not have a region prefix.
139
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
140
- @config.endpoint == Client.configure.endpoint &&
131
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
141
132
  !@config.endpoint.split(".").first.include?("-")
142
133
  credentials ||= Credentials.default scope: @config.scope,
143
134
  enable_self_signed_jwt: enable_self_signed_jwt
144
- if credentials.is_a?(String) || credentials.is_a?(Hash)
135
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
145
136
  credentials = Credentials.new credentials, scope: @config.scope
146
137
  end
147
138
  @quota_project_id = @config.quota_project
@@ -187,22 +178,37 @@ module Google
187
178
  # @param endpoint_filter [::String]
188
179
  # Optional. The filter applied to the endpoints of the resolved service.
189
180
  #
190
- # General filter string syntax:
191
- # <field> <operator> <value> (<logical connector>)
192
- # <field> can be "name" or "metadata.<key>" for map field.
193
- # <operator> can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS and is
194
- # roughly the same as "=".
195
- # <value> must be the same data type as the field.
196
- # <logical connector> can be "AND, OR, NOT".
181
+ # General `filter` string syntax:
182
+ # `<field> <operator> <value> (<logical connector>)`
183
+ #
184
+ # * `<field>` can be `name`, `address`, `port`, or `metadata.<key>` for
185
+ # map field
186
+ # * `<operator>` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:`
187
+ # means `HAS`, and is roughly the same as `=`
188
+ # * `<value>` must be the same data type as field
189
+ # * `<logical connector>` can be `AND`, `OR`, `NOT`
197
190
  #
198
191
  # Examples of valid filters:
199
- # * "metadata.owner" returns Endpoints that have a label with the
200
- # key "owner", this is the same as "metadata:owner"
201
- # * "metadata.protocol=gRPC" returns Endpoints that have key/value
202
- # "protocol=gRPC"
203
- # * "metadata.owner!=sd AND metadata.foo=bar" returns
204
- # Endpoints that have "owner" field in metadata with a value that is not
205
- # "sd" AND have the key/value foo=bar.
192
+ #
193
+ # * `metadata.owner` returns endpoints that have a annotation with the key
194
+ # `owner`, this is the same as `metadata:owner`
195
+ # * `metadata.protocol=gRPC` returns endpoints that have key/value
196
+ # `protocol=gRPC`
197
+ # * `address=192.108.1.105` returns endpoints that have this address
198
+ # * `port>8080` returns endpoints that have port number larger than 8080
199
+ # *
200
+ # `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c`
201
+ # returns endpoints that have name that is alphabetically later than the
202
+ # string, so "endpoint-e" is returned but "endpoint-a" is not
203
+ # * `metadata.owner!=sd AND metadata.foo=bar` returns endpoints that have
204
+ # `owner` in annotation key but value is not `sd` AND have key/value
205
+ # `foo=bar`
206
+ # * `doesnotexist.foo=bar` returns an empty list. Note that endpoint
207
+ # doesn't have a field called "doesnotexist". Since the filter does not
208
+ # match any endpoint, it returns no results
209
+ #
210
+ # For more information about filtering, see
211
+ # [API Filtering](https://aip.dev/160).
206
212
  #
207
213
  # @yield [response, operation] Access the result along with the RPC operation
208
214
  # @yieldparam response [::Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceResponse]
@@ -238,7 +244,9 @@ module Google
238
244
  options.apply_defaults timeout: @config.rpcs.resolve_service.timeout,
239
245
  metadata: metadata,
240
246
  retry_policy: @config.rpcs.resolve_service.retry_policy
241
- options.apply_defaults metadata: @config.metadata,
247
+
248
+ options.apply_defaults timeout: @config.timeout,
249
+ metadata: @config.metadata,
242
250
  retry_policy: @config.retry_policy
243
251
 
244
252
  @lookup_service_stub.call_rpc :resolve_service, request, options: options do |response, operation|
@@ -262,22 +270,21 @@ module Google
262
270
  # Configuration can be applied globally to all clients, or to a single client
263
271
  # on construction.
264
272
  #
265
- # # Examples
266
- #
267
- # To modify the global config, setting the timeout for resolve_service
268
- # to 20 seconds, and all remaining timeouts to 10 seconds:
269
- #
270
- # ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
271
- # config.timeout = 10.0
272
- # config.rpcs.resolve_service.timeout = 20.0
273
- # end
274
- #
275
- # To apply the above configuration only to a new client:
276
- #
277
- # client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
278
- # config.timeout = 10.0
279
- # config.rpcs.resolve_service.timeout = 20.0
280
- # end
273
+ # @example
274
+ #
275
+ # # Modify the global config, setting the timeout for
276
+ # # resolve_service to 20 seconds,
277
+ # # and all remaining timeouts to 10 seconds.
278
+ # ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
279
+ # config.timeout = 10.0
280
+ # config.rpcs.resolve_service.timeout = 20.0
281
+ # end
282
+ #
283
+ # # Apply the above configuration only to a new client.
284
+ # client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
285
+ # config.timeout = 10.0
286
+ # config.rpcs.resolve_service.timeout = 20.0
287
+ # end
281
288
  #
282
289
  # @!attribute [rw] endpoint
283
290
  # The hostname or hostname:port of the service endpoint.
data/lib/google/cloud/service_directory/v1beta1/registration_service/client.rb CHANGED
@@ -55,13 +55,12 @@ module Google
55
55
  # See {::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client::Configuration}
56
56
  # for a description of the configuration fields.
57
57
  #
58
- # ## Example
58
+ # @example
59
59
  #
60
- # To modify the configuration for all RegistrationService clients:
61
- #
62
- # ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.configure do |config|
63
- # config.timeout = 10.0
64
- # end
60
+ # # Modify the configuration for all RegistrationService clients
61
+ # ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.configure do |config|
62
+ # config.timeout = 10.0
63
+ # end
65
64
  #
66
65
  # @yield [config] Configure the Client client.
67
66
  # @yieldparam config [Client::Configuration]
@@ -81,10 +80,7 @@ module Google
81
80
 
82
81
  default_config.timeout = 15.0
83
82
  default_config.retry_policy = {
84
- initial_delay: 1.0,
85
- max_delay: 60.0,
86
- multiplier: 1.3,
87
- retry_codes: [14, 2]
83
+ initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
88
84
  }
89
85
 
90
86
  default_config
@@ -116,19 +112,15 @@ module Google
116
112
  ##
117
113
  # Create a new RegistrationService client object.
118
114
  #
119
- # ## Examples
120
- #
121
- # To create a new RegistrationService client with the default
122
- # configuration:
123
- #
124
- # client = ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new
115
+ # @example
125
116
  #
126
- # To create a new RegistrationService client with a custom
127
- # configuration:
117
+ # # Create a client using the default configuration
118
+ # client = ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new
128
119
  #
129
- # client = ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new do |config|
130
- # config.timeout = 10.0
131
- # end
120
+ # # Create a client using a custom configuration
121
+ # client = ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new do |config|
122
+ # config.timeout = 10.0
123
+ # end
132
124
  #
133
125
  # @yield [config] Configure the RegistrationService client.
134
126
  # @yieldparam config [Client::Configuration]
@@ -148,14 +140,13 @@ module Google
148
140
 
149
141
  # Create credentials
150
142
  credentials = @config.credentials
151
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
143
+ # Use self-signed JWT if the endpoint is unchanged from default,
152
144
  # but only if the default endpoint does not have a region prefix.
153
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
154
- @config.endpoint == Client.configure.endpoint &&
145
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
155
146
  !@config.endpoint.split(".").first.include?("-")
156
147
  credentials ||= Credentials.default scope: @config.scope,
157
148
  enable_self_signed_jwt: enable_self_signed_jwt
158
- if credentials.is_a?(String) || credentials.is_a?(Hash)
149
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
159
150
  credentials = Credentials.new credentials, scope: @config.scope
160
151
  end
161
152
  @quota_project_id = @config.quota_project
@@ -173,7 +164,7 @@ module Google
173
164
  # Service calls
174
165
 
175
166
  ##
176
- # Creates a namespace, and returns the new Namespace.
167
+ # Creates a namespace, and returns the new namespace.
177
168
  #
178
169
  # @overload create_namespace(request, options = nil)
179
170
  # Pass arguments to `create_namespace` via a request object, either of type
@@ -238,7 +229,9 @@ module Google
238
229
  options.apply_defaults timeout: @config.rpcs.create_namespace.timeout,
239
230
  metadata: metadata,
240
231
  retry_policy: @config.rpcs.create_namespace.retry_policy
241
- options.apply_defaults metadata: @config.metadata,
232
+
233
+ options.apply_defaults timeout: @config.timeout,
234
+ metadata: @config.metadata,
242
235
  retry_policy: @config.retry_policy
243
236
 
244
237
  @registration_service_stub.call_rpc :create_namespace, request, options: options do |response, operation|
@@ -268,46 +261,51 @@ module Google
268
261
  # the default parameter values, pass an empty Hash as a request object (see above).
269
262
  #
270
263
  # @param parent [::String]
271
- # Required. The resource name of the project and location whose namespaces we'd like to
272
- # list.
264
+ # Required. The resource name of the project and location whose namespaces you'd like
265
+ # to list.
273
266
  # @param page_size [::Integer]
274
267
  # Optional. The maximum number of items to return.
275
268
  # @param page_token [::String]
276
269
  # Optional. The next_page_token value returned from a previous List request, if any.
277
270
  # @param filter [::String]
278
- # Optional. The filter to list result by.
271
+ # Optional. The filter to list results by.
279
272
  #
280
- # General filter string syntax:
281
- # <field> <operator> <value> (<logical connector>)
282
- # <field> can be "name", or "labels.<key>" for map field.
283
- # <operator> can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and
284
- # is roughly the same as "=".
285
- # <value> must be the same data type as field.
286
- # <logical connector> can be "AND, OR, NOT".
273
+ # General `filter` string syntax:
274
+ # `<field> <operator> <value> (<logical connector>)`
275
+ #
276
+ # * `<field>` can be `name` or `labels.<key>` for map field
277
+ # * `<operator>` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:`
278
+ # means `HAS`, and is roughly the same as `=`
279
+ # * `<value>` must be the same data type as field
280
+ # * `<logical connector>` can be `AND`, `OR`, `NOT`
287
281
  #
288
282
  # Examples of valid filters:
289
- # * "labels.owner" returns Namespaces that have a label with the key "owner"
290
- # this is the same as "labels:owner".
291
- # * "labels.protocol=gRPC" returns Namespaces that have key/value
292
- # "protocol=gRPC".
293
- # * "name>projects/my-project/locations/us-east/namespaces/namespace-c"
294
- # returns Namespaces that have name that is alphabetically later than the
295
- # string, so "namespace-e" will be returned but "namespace-a" will not be.
296
- # * "labels.owner!=sd AND labels.foo=bar" returns Namespaces that have
297
- # "owner" in label key but value is not "sd" AND have key/value foo=bar.
298
- # * "doesnotexist.foo=bar" returns an empty list. Note that Namespace doesn't
299
- # have a field called "doesnotexist". Since the filter does not match any
300
- # Namespaces, it returns no results.
283
+ #
284
+ # * `labels.owner` returns namespaces that have a label with the key
285
+ # `owner`, this is the same as `labels:owner`
286
+ # * `labels.owner=sd` returns namespaces that have key/value `owner=sd`
287
+ # * `name>projects/my-project/locations/us-east1/namespaces/namespace-c`
288
+ # returns namespaces that have name that is alphabetically later than the
289
+ # string, so "namespace-e" is returned but "namespace-a" is not
290
+ # * `labels.owner!=sd AND labels.foo=bar` returns namespaces that have
291
+ # `owner` in label key but value is not `sd` AND have key/value `foo=bar`
292
+ # * `doesnotexist.foo=bar` returns an empty list. Note that namespace
293
+ # doesn't have a field called "doesnotexist". Since the filter does not
294
+ # match any namespaces, it returns no results
295
+ #
296
+ # For more information about filtering, see
297
+ # [API Filtering](https://aip.dev/160).
301
298
  # @param order_by [::String]
302
- # Optional. The order to list result by.
299
+ # Optional. The order to list results by.
300
+ #
301
+ # General `order_by` string syntax: `<field> (<asc|desc>) (,)`
303
302
  #
304
- # General order by string syntax:
305
- # <field> (<asc|desc>) (,)
306
- # <field> allows values \\{"name"}
307
- # <asc/desc> ascending or descending order by <field>. If this is left
308
- # blank, "asc" is used.
309
- # Note that an empty order_by string result in default order, which is order
310
- # by name in ascending order.
303
+ # * `<field>` allows value: `name`
304
+ # * `<asc|desc>` ascending or descending order by `<field>`. If this is
305
+ # left blank, `asc` is used
306
+ #
307
+ # Note that an empty `order_by` string results in default order, which is
308
+ # order by `name` in ascending order.
311
309
  #
312
310
  # @yield [response, operation] Access the result along with the RPC operation
313
311
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ServiceDirectory::V1beta1::Namespace>]
@@ -343,7 +341,9 @@ module Google
343
341
  options.apply_defaults timeout: @config.rpcs.list_namespaces.timeout,
344
342
  metadata: metadata,
345
343
  retry_policy: @config.rpcs.list_namespaces.retry_policy
346
- options.apply_defaults metadata: @config.metadata,
344
+
345
+ options.apply_defaults timeout: @config.timeout,
346
+ metadata: @config.metadata,
347
347
  retry_policy: @config.retry_policy
348
348
 
349
349
  @registration_service_stub.call_rpc :list_namespaces, request, options: options do |response, operation|
@@ -410,7 +410,9 @@ module Google
410
410
  options.apply_defaults timeout: @config.rpcs.get_namespace.timeout,
411
411
  metadata: metadata,
412
412
  retry_policy: @config.rpcs.get_namespace.retry_policy
413
- options.apply_defaults metadata: @config.metadata,
413
+
414
+ options.apply_defaults timeout: @config.timeout,
415
+ metadata: @config.metadata,
414
416
  retry_policy: @config.retry_policy
415
417
 
416
418
  @registration_service_stub.call_rpc :get_namespace, request, options: options do |response, operation|
@@ -478,7 +480,9 @@ module Google
478
480
  options.apply_defaults timeout: @config.rpcs.update_namespace.timeout,
479
481
  metadata: metadata,
480
482
  retry_policy: @config.rpcs.update_namespace.retry_policy
481
- options.apply_defaults metadata: @config.metadata,
483
+
484
+ options.apply_defaults timeout: @config.timeout,
485
+ metadata: @config.metadata,
482
486
  retry_policy: @config.retry_policy
483
487
 
484
488
  @registration_service_stub.call_rpc :update_namespace, request, options: options do |response, operation|
@@ -545,7 +549,9 @@ module Google
545
549
  options.apply_defaults timeout: @config.rpcs.delete_namespace.timeout,
546
550
  metadata: metadata,
547
551
  retry_policy: @config.rpcs.delete_namespace.retry_policy
548
- options.apply_defaults metadata: @config.metadata,
552
+
553
+ options.apply_defaults timeout: @config.timeout,
554
+ metadata: @config.metadata,
549
555
  retry_policy: @config.retry_policy
550
556
 
551
557
  @registration_service_stub.call_rpc :delete_namespace, request, options: options do |response, operation|
@@ -557,7 +563,7 @@ module Google
557
563
  end
558
564
 
559
565
  ##
560
- # Creates a service, and returns the new Service.
566
+ # Creates a service, and returns the new service.
561
567
  #
562
568
  # @overload create_service(request, options = nil)
563
569
  # Pass arguments to `create_service` via a request object, either of type
@@ -621,7 +627,9 @@ module Google
621
627
  options.apply_defaults timeout: @config.rpcs.create_service.timeout,
622
628
  metadata: metadata,
623
629
  retry_policy: @config.rpcs.create_service.retry_policy
624
- options.apply_defaults metadata: @config.metadata,
630
+
631
+ options.apply_defaults timeout: @config.timeout,
632
+ metadata: @config.metadata,
625
633
  retry_policy: @config.retry_policy
626
634
 
627
635
  @registration_service_stub.call_rpc :create_service, request, options: options do |response, operation|
@@ -651,7 +659,7 @@ module Google
651
659
  # the default parameter values, pass an empty Hash as a request object (see above).
652
660
  #
653
661
  # @param parent [::String]
654
- # Required. The resource name of the namespace whose services we'd
662
+ # Required. The resource name of the namespace whose services you'd
655
663
  # like to list.
656
664
  # @param page_size [::Integer]
657
665
  # Optional. The maximum number of items to return.
@@ -659,31 +667,47 @@ module Google
659
667
  # Optional. The next_page_token value returned from a previous List request,
660
668
  # if any.
661
669
  # @param filter [::String]
662
- # Optional. The filter to list result by.
670
+ # Optional. The filter to list results by.
671
+ #
672
+ # General `filter` string syntax:
673
+ # `<field> <operator> <value> (<logical connector>)`
663
674
  #
664
- # General filter string syntax:
665
- # <field> <operator> <value> (<logical connector>)
666
- # <field> can be "name", or "metadata.<key>" for map field.
667
- # <operator> can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and
668
- # is roughly the same as "=".
669
- # <value> must be the same data type as field.
670
- # <logical connector> can be "AND, OR, NOT".
675
+ # * `<field>` can be `name` or `metadata.<key>` for map field
676
+ # * `<operator>` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:`
677
+ # means `HAS`, and is roughly the same as `=`
678
+ # * `<value>` must be the same data type as field
679
+ # * `<logical connector>` can be `AND`, `OR`, `NOT`
671
680
  #
672
681
  # Examples of valid filters:
673
- # * "metadata.owner" returns Services that have a label with the key "owner"
674
- # this is the same as "metadata:owner".
675
- # * "metadata.protocol=gRPC" returns Services that have key/value
676
- # "protocol=gRPC".
677
- # * "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/service-c"
678
- # returns Services that have name that is alphabetically later than the
679
- # string, so "service-e" will be returned but "service-a" will not be.
680
- # * "metadata.owner!=sd AND metadata.foo=bar" returns Services that have
681
- # "owner" in label key but value is not "sd" AND have key/value foo=bar.
682
- # * "doesnotexist.foo=bar" returns an empty list. Note that Service doesn't
683
- # have a field called "doesnotexist". Since the filter does not match any
684
- # Services, it returns no results.
682
+ #
683
+ # * `metadata.owner` returns services that have a metadata with the key
684
+ # `owner`, this is the same as `metadata:owner`
685
+ # * `metadata.protocol=gRPC` returns services that have key/value
686
+ # `protocol=gRPC`
687
+ # *
688
+ # `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c`
689
+ # returns services that have name that is alphabetically later than the
690
+ # string, so "service-e" is returned but "service-a" is not
691
+ # * `metadata.owner!=sd AND metadata.foo=bar` returns services that have
692
+ # `owner` in metadata key but value is not `sd` AND have key/value
693
+ # `foo=bar`
694
+ # * `doesnotexist.foo=bar` returns an empty list. Note that service
695
+ # doesn't have a field called "doesnotexist". Since the filter does not
696
+ # match any services, it returns no results
697
+ #
698
+ # For more information about filtering, see
699
+ # [API Filtering](https://aip.dev/160).
685
700
  # @param order_by [::String]
686
- # Optional. The order to list result by.
701
+ # Optional. The order to list results by.
702
+ #
703
+ # General `order_by` string syntax: `<field> (<asc|desc>) (,)`
704
+ #
705
+ # * `<field>` allows value: `name`
706
+ # * `<asc|desc>` ascending or descending order by `<field>`. If this is
707
+ # left blank, `asc` is used
708
+ #
709
+ # Note that an empty `order_by` string results in default order, which is
710
+ # order by `name` in ascending order.
687
711
  #
688
712
  # @yield [response, operation] Access the result along with the RPC operation
689
713
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ServiceDirectory::V1beta1::Service>]
@@ -719,7 +743,9 @@ module Google
719
743
  options.apply_defaults timeout: @config.rpcs.list_services.timeout,
720
744
  metadata: metadata,
721
745
  retry_policy: @config.rpcs.list_services.retry_policy
722
- options.apply_defaults metadata: @config.metadata,
746
+
747
+ options.apply_defaults timeout: @config.timeout,
748
+ metadata: @config.metadata,
723
749
  retry_policy: @config.retry_policy
724
750
 
725
751
  @registration_service_stub.call_rpc :list_services, request, options: options do |response, operation|
@@ -786,7 +812,9 @@ module Google
786
812
  options.apply_defaults timeout: @config.rpcs.get_service.timeout,
787
813
  metadata: metadata,
788
814
  retry_policy: @config.rpcs.get_service.retry_policy
789
- options.apply_defaults metadata: @config.metadata,
815
+
816
+ options.apply_defaults timeout: @config.timeout,
817
+ metadata: @config.metadata,
790
818
  retry_policy: @config.retry_policy
791
819
 
792
820
  @registration_service_stub.call_rpc :get_service, request, options: options do |response, operation|
@@ -854,7 +882,9 @@ module Google
854
882
  options.apply_defaults timeout: @config.rpcs.update_service.timeout,
855
883
  metadata: metadata,
856
884
  retry_policy: @config.rpcs.update_service.retry_policy
857
- options.apply_defaults metadata: @config.metadata,
885
+
886
+ options.apply_defaults timeout: @config.timeout,
887
+ metadata: @config.metadata,
858
888
  retry_policy: @config.retry_policy
859
889
 
860
890
  @registration_service_stub.call_rpc :update_service, request, options: options do |response, operation|
@@ -921,7 +951,9 @@ module Google
921
951
  options.apply_defaults timeout: @config.rpcs.delete_service.timeout,
922
952
  metadata: metadata,
923
953
  retry_policy: @config.rpcs.delete_service.retry_policy
924
- options.apply_defaults metadata: @config.metadata,
954
+
955
+ options.apply_defaults timeout: @config.timeout,
956
+ metadata: @config.metadata,
925
957
  retry_policy: @config.retry_policy
926
958
 
927
959
  @registration_service_stub.call_rpc :delete_service, request, options: options do |response, operation|
@@ -933,7 +965,7 @@ module Google
933
965
  end
934
966
 
935
967
  ##
936
- # Creates a endpoint, and returns the new Endpoint.
968
+ # Creates an endpoint, and returns the new endpoint.
937
969
  #
938
970
  # @overload create_endpoint(request, options = nil)
939
971
  # Pass arguments to `create_endpoint` via a request object, either of type
@@ -997,7 +1029,9 @@ module Google
997
1029
  options.apply_defaults timeout: @config.rpcs.create_endpoint.timeout,
998
1030
  metadata: metadata,
999
1031
  retry_policy: @config.rpcs.create_endpoint.retry_policy
1000
- options.apply_defaults metadata: @config.metadata,
1032
+
1033
+ options.apply_defaults timeout: @config.timeout,
1034
+ metadata: @config.metadata,
1001
1035
  retry_policy: @config.retry_policy
1002
1036
 
1003
1037
  @registration_service_stub.call_rpc :create_endpoint, request, options: options do |response, operation|
@@ -1027,7 +1061,7 @@ module Google
1027
1061
  # the default parameter values, pass an empty Hash as a request object (see above).
1028
1062
  #
1029
1063
  # @param parent [::String]
1030
- # Required. The resource name of the service whose endpoints we'd like to
1064
+ # Required. The resource name of the service whose endpoints you'd like to
1031
1065
  # list.
1032
1066
  # @param page_size [::Integer]
1033
1067
  # Optional. The maximum number of items to return.
@@ -1035,33 +1069,50 @@ module Google
1035
1069
  # Optional. The next_page_token value returned from a previous List request,
1036
1070
  # if any.
1037
1071
  # @param filter [::String]
1038
- # Optional. The filter to list result by.
1072
+ # Optional. The filter to list results by.
1073
+ #
1074
+ # General `filter` string syntax:
1075
+ # `<field> <operator> <value> (<logical connector>)`
1039
1076
  #
1040
- # General filter string syntax:
1041
- # <field> <operator> <value> (<logical connector>)
1042
- # <field> can be "name", "address", "port" or "metadata.<key>" for map field.
1043
- # <operator> can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and
1044
- # is roughly the same as "=".
1045
- # <value> must be the same data type as field.
1046
- # <logical connector> can be "AND, OR, NOT".
1077
+ # * `<field>` can be `name`, `address`, `port`, or `metadata.<key>` for map
1078
+ # field
1079
+ # * `<operator>` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:`
1080
+ # means `HAS`, and is roughly the same as `=`
1081
+ # * `<value>` must be the same data type as field
1082
+ # * `<logical connector>` can be `AND`, `OR`, `NOT`
1047
1083
  #
1048
1084
  # Examples of valid filters:
1049
- # * "metadata.owner" returns Endpoints that have a label with the key "owner"
1050
- # this is the same as "metadata:owner".
1051
- # * "metadata.protocol=gRPC" returns Endpoints that have key/value
1052
- # "protocol=gRPC".
1053
- # * "address=192.108.1.105" returns Endpoints that have this address.
1054
- # * "port>8080" returns Endpoints that have port number larger than 8080.
1055
- # * "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/my-service/endpoints/endpoint-c"
1056
- # returns Endpoints that have name that is alphabetically later than the
1057
- # string, so "endpoint-e" will be returned but "endpoint-a" will not be.
1058
- # * "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints that have
1059
- # "owner" in label key but value is not "sd" AND have key/value foo=bar.
1060
- # * "doesnotexist.foo=bar" returns an empty list. Note that Endpoint doesn't
1061
- # have a field called "doesnotexist". Since the filter does not match any
1062
- # Endpoints, it returns no results.
1085
+ #
1086
+ # * `metadata.owner` returns endpoints that have a metadata with the key
1087
+ # `owner`, this is the same as `metadata:owner`
1088
+ # * `metadata.protocol=gRPC` returns endpoints that have key/value
1089
+ # `protocol=gRPC`
1090
+ # * `address=192.108.1.105` returns endpoints that have this address
1091
+ # * `port>8080` returns endpoints that have port number larger than 8080
1092
+ # *
1093
+ # `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c`
1094
+ # returns endpoints that have name that is alphabetically later than the
1095
+ # string, so "endpoint-e" is returned but "endpoint-a" is not
1096
+ # * `metadata.owner!=sd AND metadata.foo=bar` returns endpoints that have
1097
+ # `owner` in metadata key but value is not `sd` AND have key/value
1098
+ # `foo=bar`
1099
+ # * `doesnotexist.foo=bar` returns an empty list. Note that endpoint
1100
+ # doesn't have a field called "doesnotexist". Since the filter does not
1101
+ # match any endpoints, it returns no results
1102
+ #
1103
+ # For more information about filtering, see
1104
+ # [API Filtering](https://aip.dev/160).
1063
1105
  # @param order_by [::String]
1064
- # Optional. The order to list result by.
1106
+ # Optional. The order to list results by.
1107
+ #
1108
+ # General `order_by` string syntax: `<field> (<asc|desc>) (,)`
1109
+ #
1110
+ # * `<field>` allows values: `name`, `address`, `port`
1111
+ # * `<asc|desc>` ascending or descending order by `<field>`. If this is
1112
+ # left blank, `asc` is used
1113
+ #
1114
+ # Note that an empty `order_by` string results in default order, which is
1115
+ # order by `name` in ascending order.
1065
1116
  #
1066
1117
  # @yield [response, operation] Access the result along with the RPC operation
1067
1118
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ServiceDirectory::V1beta1::Endpoint>]
@@ -1097,7 +1148,9 @@ module Google
1097
1148
  options.apply_defaults timeout: @config.rpcs.list_endpoints.timeout,
1098
1149
  metadata: metadata,
1099
1150
  retry_policy: @config.rpcs.list_endpoints.retry_policy
1100
- options.apply_defaults metadata: @config.metadata,
1151
+
1152
+ options.apply_defaults timeout: @config.timeout,
1153
+ metadata: @config.metadata,
1101
1154
  retry_policy: @config.retry_policy
1102
1155
 
1103
1156
  @registration_service_stub.call_rpc :list_endpoints, request, options: options do |response, operation|
@@ -1110,7 +1163,7 @@ module Google
1110
1163
  end
1111
1164
 
1112
1165
  ##
1113
- # Gets a endpoint.
1166
+ # Gets an endpoint.
1114
1167
  #
1115
1168
  # @overload get_endpoint(request, options = nil)
1116
1169
  # Pass arguments to `get_endpoint` via a request object, either of type
@@ -1164,7 +1217,9 @@ module Google
1164
1217
  options.apply_defaults timeout: @config.rpcs.get_endpoint.timeout,
1165
1218
  metadata: metadata,
1166
1219
  retry_policy: @config.rpcs.get_endpoint.retry_policy
1167
- options.apply_defaults metadata: @config.metadata,
1220
+
1221
+ options.apply_defaults timeout: @config.timeout,
1222
+ metadata: @config.metadata,
1168
1223
  retry_policy: @config.retry_policy
1169
1224
 
1170
1225
  @registration_service_stub.call_rpc :get_endpoint, request, options: options do |response, operation|
@@ -1176,7 +1231,7 @@ module Google
1176
1231
  end
1177
1232
 
1178
1233
  ##
1179
- # Updates a endpoint.
1234
+ # Updates an endpoint.
1180
1235
  #
1181
1236
  # @overload update_endpoint(request, options = nil)
1182
1237
  # Pass arguments to `update_endpoint` via a request object, either of type
@@ -1232,7 +1287,9 @@ module Google
1232
1287
  options.apply_defaults timeout: @config.rpcs.update_endpoint.timeout,
1233
1288
  metadata: metadata,
1234
1289
  retry_policy: @config.rpcs.update_endpoint.retry_policy
1235
- options.apply_defaults metadata: @config.metadata,
1290
+
1291
+ options.apply_defaults timeout: @config.timeout,
1292
+ metadata: @config.metadata,
1236
1293
  retry_policy: @config.retry_policy
1237
1294
 
1238
1295
  @registration_service_stub.call_rpc :update_endpoint, request, options: options do |response, operation|
@@ -1244,7 +1301,7 @@ module Google
1244
1301
  end
1245
1302
 
1246
1303
  ##
1247
- # Deletes a endpoint.
1304
+ # Deletes an endpoint.
1248
1305
  #
1249
1306
  # @overload delete_endpoint(request, options = nil)
1250
1307
  # Pass arguments to `delete_endpoint` via a request object, either of type
@@ -1298,7 +1355,9 @@ module Google
1298
1355
  options.apply_defaults timeout: @config.rpcs.delete_endpoint.timeout,
1299
1356
  metadata: metadata,
1300
1357
  retry_policy: @config.rpcs.delete_endpoint.retry_policy
1301
- options.apply_defaults metadata: @config.metadata,
1358
+
1359
+ options.apply_defaults timeout: @config.timeout,
1360
+ metadata: @config.metadata,
1302
1361
  retry_policy: @config.retry_policy
1303
1362
 
1304
1363
  @registration_service_stub.call_rpc :delete_endpoint, request, options: options do |response, operation|
@@ -1368,7 +1427,9 @@ module Google
1368
1427
  options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout,
1369
1428
  metadata: metadata,
1370
1429
  retry_policy: @config.rpcs.get_iam_policy.retry_policy
1371
- options.apply_defaults metadata: @config.metadata,
1430
+
1431
+ options.apply_defaults timeout: @config.timeout,
1432
+ metadata: @config.metadata,
1372
1433
  retry_policy: @config.retry_policy
1373
1434
 
1374
1435
  @registration_service_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
@@ -1440,7 +1501,9 @@ module Google
1440
1501
  options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout,
1441
1502
  metadata: metadata,
1442
1503
  retry_policy: @config.rpcs.set_iam_policy.retry_policy
1443
- options.apply_defaults metadata: @config.metadata,
1504
+
1505
+ options.apply_defaults timeout: @config.timeout,
1506
+ metadata: @config.metadata,
1444
1507
  retry_policy: @config.retry_policy
1445
1508
 
1446
1509
  @registration_service_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
@@ -1512,7 +1575,9 @@ module Google
1512
1575
  options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout,
1513
1576
  metadata: metadata,
1514
1577
  retry_policy: @config.rpcs.test_iam_permissions.retry_policy
1515
- options.apply_defaults metadata: @config.metadata,
1578
+
1579
+ options.apply_defaults timeout: @config.timeout,
1580
+ metadata: @config.metadata,
1516
1581
  retry_policy: @config.retry_policy
1517
1582
 
1518
1583
  @registration_service_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
@@ -1536,22 +1601,21 @@ module Google
1536
1601
  # Configuration can be applied globally to all clients, or to a single client
1537
1602
  # on construction.
1538
1603
  #
1539
- # # Examples
1540
- #
1541
- # To modify the global config, setting the timeout for create_namespace
1542
- # to 20 seconds, and all remaining timeouts to 10 seconds:
1543
- #
1544
- # ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.configure do |config|
1545
- # config.timeout = 10.0
1546
- # config.rpcs.create_namespace.timeout = 20.0
1547
- # end
1548
- #
1549
- # To apply the above configuration only to a new client:
1550
- #
1551
- # client = ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new do |config|
1552
- # config.timeout = 10.0
1553
- # config.rpcs.create_namespace.timeout = 20.0
1554
- # end
1604
+ # @example
1605
+ #
1606
+ # # Modify the global config, setting the timeout for
1607
+ # # create_namespace to 20 seconds,
1608
+ # # and all remaining timeouts to 10 seconds.
1609
+ # ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.configure do |config|
1610
+ # config.timeout = 10.0
1611
+ # config.rpcs.create_namespace.timeout = 20.0
1612
+ # end
1613
+ #
1614
+ # # Apply the above configuration only to a new client.
1615
+ # client = ::Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new do |config|
1616
+ # config.timeout = 10.0
1617
+ # config.rpcs.create_namespace.timeout = 20.0
1618
+ # end
1555
1619
  #
1556
1620
  # @!attribute [rw] endpoint
1557
1621
  # The hostname or hostname:port of the service endpoint.