google-cloud-vision-v1 0.2.5 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -103,8 +103,13 @@ module Google
103
103
  # Lists operations that match the specified filter in the request. If the
104
104
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
105
105
  #
106
- # NOTE: the `name` binding below allows API services to override the binding
107
- # to use different resource name schemes, such as `users/*/operations`.
106
+ # NOTE: the `name` binding allows API services to override the binding
107
+ # to use different resource name schemes, such as `users/*/operations`. To
108
+ # override the binding, API services can add a binding such as
109
+ # `"/v1/{name=users/*}/operations"` to their service configuration.
110
+ # For backwards compatibility, the default name includes the operations
111
+ # collection id, however overriding users must ensure the name binding
112
+ # is the parent resource, without the operations collection id.
108
113
  #
109
114
  # @overload list_operations(request, options = nil)
110
115
  # Pass arguments to `list_operations` via a request object, either of type
@@ -122,7 +127,7 @@ module Google
122
127
  # the default parameter values, pass an empty Hash as a request object (see above).
123
128
  #
124
129
  # @param name [::String]
125
- # The name of the operation collection.
130
+ # The name of the operation's parent resource.
126
131
  # @param filter [::String]
127
132
  # The standard list filter.
128
133
  # @param page_size [::Integer]
@@ -390,6 +395,79 @@ module Google
390
395
  raise ::Google::Cloud::Error.from_error(e)
391
396
  end
392
397
 
398
+ ##
399
+ # Waits for the specified long-running operation until it is done or reaches
400
+ # at most a specified timeout, returning the latest state. If the operation
401
+ # is already done, the latest state is immediately returned. If the timeout
402
+ # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
403
+ # timeout is used. If the server does not support this method, it returns
404
+ # `google.rpc.Code.UNIMPLEMENTED`.
405
+ # Note that this method is on a best-effort basis. It may return the latest
406
+ # state before the specified timeout (including immediately), meaning even an
407
+ # immediate response is no guarantee that the operation is done.
408
+ #
409
+ # @overload wait_operation(request, options = nil)
410
+ # Pass arguments to `wait_operation` via a request object, either of type
411
+ # {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
412
+ #
413
+ # @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
414
+ # A request object representing the call parameters. Required. To specify no
415
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
416
+ # @param options [::Gapic::CallOptions, ::Hash]
417
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
418
+ #
419
+ # @overload wait_operation(name: nil, timeout: nil)
420
+ # Pass arguments to `wait_operation` via keyword arguments. Note that at
421
+ # least one keyword argument is required. To specify no parameters, or to keep all
422
+ # the default parameter values, pass an empty Hash as a request object (see above).
423
+ #
424
+ # @param name [::String]
425
+ # The name of the operation resource to wait on.
426
+ # @param timeout [::Google::Protobuf::Duration, ::Hash]
427
+ # The maximum duration to wait before timing out. If left blank, the wait
428
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
429
+ # If RPC context deadline is also specified, the shorter one will be used.
430
+ #
431
+ # @yield [response, operation] Access the result along with the RPC operation
432
+ # @yieldparam response [::Gapic::Operation]
433
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
434
+ #
435
+ # @return [::Gapic::Operation]
436
+ #
437
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
438
+ #
439
+ def wait_operation request, options = nil
440
+ raise ::ArgumentError, "request must be provided" if request.nil?
441
+
442
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
443
+
444
+ # Converts hash and nil to an options object
445
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
446
+
447
+ # Customize the options with defaults
448
+ metadata = @config.rpcs.wait_operation.metadata.to_h
449
+
450
+ # Set x-goog-api-client and x-goog-user-project headers
451
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
452
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
453
+ gapic_version: ::Google::Cloud::Vision::V1::VERSION
454
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
455
+
456
+ options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
+ metadata: metadata,
458
+ retry_policy: @config.rpcs.wait_operation.retry_policy
459
+ options.apply_defaults metadata: @config.metadata,
460
+ retry_policy: @config.retry_policy
461
+
462
+ @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
463
+ response = ::Gapic::Operation.new response, @operations_client, options: options
464
+ yield response, operation if block_given?
465
+ return response
466
+ end
467
+ rescue ::GRPC::BadStatus => e
468
+ raise ::Google::Cloud::Error.from_error(e)
469
+ end
470
+
393
471
  ##
394
472
  # Configuration class for the Operations API.
395
473
  #
@@ -482,7 +560,7 @@ module Google
482
560
  config_attr :scope, nil, ::String, ::Array, nil
483
561
  config_attr :lib_name, nil, ::String, nil
484
562
  config_attr :lib_version, nil, ::String, nil
485
- config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
563
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
486
564
  config_attr :interceptors, nil, ::Array, nil
487
565
  config_attr :timeout, nil, ::Numeric, nil
488
566
  config_attr :metadata, nil, ::Hash, nil
@@ -503,7 +581,7 @@ module Google
503
581
  def rpcs
504
582
  @rpcs ||= begin
505
583
  parent_rpcs = nil
506
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
584
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
507
585
  Rpcs.new parent_rpcs
508
586
  end
509
587
  end
@@ -515,7 +593,7 @@ module Google
515
593
  # Each configuration object is of type `Gapic::Config::Method` and includes
516
594
  # the following configuration fields:
517
595
  #
518
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
596
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
519
597
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
520
598
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
521
599
  # include the following keys:
@@ -546,17 +624,24 @@ module Google
546
624
  # @return [::Gapic::Config::Method]
547
625
  #
548
626
  attr_reader :cancel_operation
627
+ ##
628
+ # RPC-specific configuration for `wait_operation`
629
+ # @return [::Gapic::Config::Method]
630
+ #
631
+ attr_reader :wait_operation
549
632
 
550
633
  # @private
551
634
  def initialize parent_rpcs = nil
552
- list_operations_config = parent_rpcs&.list_operations if parent_rpcs&.respond_to? :list_operations
635
+ list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
553
636
  @list_operations = ::Gapic::Config::Method.new list_operations_config
554
- get_operation_config = parent_rpcs&.get_operation if parent_rpcs&.respond_to? :get_operation
637
+ get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
555
638
  @get_operation = ::Gapic::Config::Method.new get_operation_config
556
- delete_operation_config = parent_rpcs&.delete_operation if parent_rpcs&.respond_to? :delete_operation
639
+ delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
557
640
  @delete_operation = ::Gapic::Config::Method.new delete_operation_config
558
- cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
641
+ cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
559
642
  @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
643
+ wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
644
+ @wait_operation = ::Gapic::Config::Method.new wait_operation_config
560
645
 
561
646
  yield self if block_given?
562
647
  end
@@ -3,11 +3,11 @@
3
3
 
4
4
  require 'google/protobuf'
5
5
 
6
+ require 'google/api/resource_pb'
6
7
  require 'google/cloud/vision/v1/geometry_pb'
7
8
  require 'google/cloud/vision/v1/product_search_service_pb'
8
9
  require 'google/protobuf/timestamp_pb'
9
10
  require 'google/api/annotations_pb'
10
- require 'google/api/resource_pb'
11
11
  Google::Protobuf::DescriptorPool.generated_pool.build do
12
12
  add_file("google/cloud/vision/v1/product_search.proto", :syntax => :proto3) do
13
13
  add_message "google.cloud.vision.v1.ProductSearchParams" do
@@ -1,7 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # Source: google/cloud/vision/v1/product_search_service.proto for package 'google.cloud.vision.v1'
3
3
  # Original file comments:
4
- # Copyright 2019 Google LLC.
4
+ # Copyright 2020 Google LLC
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
15
15
  # See the License for the specific language governing permissions and
16
16
  # limitations under the License.
17
17
  #
18
- #
19
18
 
20
19
  require 'grpc'
21
20
  require 'google/cloud/vision/v1/product_search_service_pb'
@@ -53,20 +52,20 @@ module Google
53
52
  #
54
53
  # * Returns INVALID_ARGUMENT if display_name is missing, or is longer than
55
54
  # 4096 characters.
56
- rpc :CreateProductSet, Google::Cloud::Vision::V1::CreateProductSetRequest, Google::Cloud::Vision::V1::ProductSet
55
+ rpc :CreateProductSet, ::Google::Cloud::Vision::V1::CreateProductSetRequest, ::Google::Cloud::Vision::V1::ProductSet
57
56
  # Lists ProductSets in an unspecified order.
58
57
  #
59
58
  # Possible errors:
60
59
  #
61
60
  # * Returns INVALID_ARGUMENT if page_size is greater than 100, or less
62
61
  # than 1.
63
- rpc :ListProductSets, Google::Cloud::Vision::V1::ListProductSetsRequest, Google::Cloud::Vision::V1::ListProductSetsResponse
62
+ rpc :ListProductSets, ::Google::Cloud::Vision::V1::ListProductSetsRequest, ::Google::Cloud::Vision::V1::ListProductSetsResponse
64
63
  # Gets information associated with a ProductSet.
65
64
  #
66
65
  # Possible errors:
67
66
  #
68
67
  # * Returns NOT_FOUND if the ProductSet does not exist.
69
- rpc :GetProductSet, Google::Cloud::Vision::V1::GetProductSetRequest, Google::Cloud::Vision::V1::ProductSet
68
+ rpc :GetProductSet, ::Google::Cloud::Vision::V1::GetProductSetRequest, ::Google::Cloud::Vision::V1::ProductSet
70
69
  # Makes changes to a ProductSet resource.
71
70
  # Only display_name can be updated currently.
72
71
  #
@@ -75,12 +74,12 @@ module Google
75
74
  # * Returns NOT_FOUND if the ProductSet does not exist.
76
75
  # * Returns INVALID_ARGUMENT if display_name is present in update_mask but
77
76
  # missing from the request or longer than 4096 characters.
78
- rpc :UpdateProductSet, Google::Cloud::Vision::V1::UpdateProductSetRequest, Google::Cloud::Vision::V1::ProductSet
77
+ rpc :UpdateProductSet, ::Google::Cloud::Vision::V1::UpdateProductSetRequest, ::Google::Cloud::Vision::V1::ProductSet
79
78
  # Permanently deletes a ProductSet. Products and ReferenceImages in the
80
79
  # ProductSet are not deleted.
81
80
  #
82
81
  # The actual image files are not deleted from Google Cloud Storage.
83
- rpc :DeleteProductSet, Google::Cloud::Vision::V1::DeleteProductSetRequest, Google::Protobuf::Empty
82
+ rpc :DeleteProductSet, ::Google::Cloud::Vision::V1::DeleteProductSetRequest, ::Google::Protobuf::Empty
84
83
  # Creates and returns a new product resource.
85
84
  #
86
85
  # Possible errors:
@@ -89,19 +88,19 @@ module Google
89
88
  # characters.
90
89
  # * Returns INVALID_ARGUMENT if description is longer than 4096 characters.
91
90
  # * Returns INVALID_ARGUMENT if product_category is missing or invalid.
92
- rpc :CreateProduct, Google::Cloud::Vision::V1::CreateProductRequest, Google::Cloud::Vision::V1::Product
91
+ rpc :CreateProduct, ::Google::Cloud::Vision::V1::CreateProductRequest, ::Google::Cloud::Vision::V1::Product
93
92
  # Lists products in an unspecified order.
94
93
  #
95
94
  # Possible errors:
96
95
  #
97
96
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
98
- rpc :ListProducts, Google::Cloud::Vision::V1::ListProductsRequest, Google::Cloud::Vision::V1::ListProductsResponse
97
+ rpc :ListProducts, ::Google::Cloud::Vision::V1::ListProductsRequest, ::Google::Cloud::Vision::V1::ListProductsResponse
99
98
  # Gets information associated with a Product.
100
99
  #
101
100
  # Possible errors:
102
101
  #
103
102
  # * Returns NOT_FOUND if the Product does not exist.
104
- rpc :GetProduct, Google::Cloud::Vision::V1::GetProductRequest, Google::Cloud::Vision::V1::Product
103
+ rpc :GetProduct, ::Google::Cloud::Vision::V1::GetProductRequest, ::Google::Cloud::Vision::V1::Product
105
104
  # Makes changes to a Product resource.
106
105
  # Only the `display_name`, `description`, and `labels` fields can be updated
107
106
  # right now.
@@ -117,13 +116,13 @@ module Google
117
116
  # * Returns INVALID_ARGUMENT if description is present in update_mask but is
118
117
  # longer than 4096 characters.
119
118
  # * Returns INVALID_ARGUMENT if product_category is present in update_mask.
120
- rpc :UpdateProduct, Google::Cloud::Vision::V1::UpdateProductRequest, Google::Cloud::Vision::V1::Product
119
+ rpc :UpdateProduct, ::Google::Cloud::Vision::V1::UpdateProductRequest, ::Google::Cloud::Vision::V1::Product
121
120
  # Permanently deletes a product and its reference images.
122
121
  #
123
122
  # Metadata of the product and all its images will be deleted right away, but
124
123
  # search queries against ProductSets containing the product may still work
125
124
  # until all related caches are refreshed.
126
- rpc :DeleteProduct, Google::Cloud::Vision::V1::DeleteProductRequest, Google::Protobuf::Empty
125
+ rpc :DeleteProduct, ::Google::Cloud::Vision::V1::DeleteProductRequest, ::Google::Protobuf::Empty
127
126
  # Creates and returns a new ReferenceImage resource.
128
127
  #
129
128
  # The `bounding_poly` field is optional. If `bounding_poly` is not specified,
@@ -143,7 +142,7 @@ module Google
143
142
  # * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
144
143
  # compatible with the parent product's product_category is detected.
145
144
  # * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
146
- rpc :CreateReferenceImage, Google::Cloud::Vision::V1::CreateReferenceImageRequest, Google::Cloud::Vision::V1::ReferenceImage
145
+ rpc :CreateReferenceImage, ::Google::Cloud::Vision::V1::CreateReferenceImageRequest, ::Google::Cloud::Vision::V1::ReferenceImage
147
146
  # Permanently deletes a reference image.
148
147
  #
149
148
  # The image metadata will be deleted right away, but search queries
@@ -151,7 +150,7 @@ module Google
151
150
  # caches are refreshed.
152
151
  #
153
152
  # The actual image files are not deleted from Google Cloud Storage.
154
- rpc :DeleteReferenceImage, Google::Cloud::Vision::V1::DeleteReferenceImageRequest, Google::Protobuf::Empty
153
+ rpc :DeleteReferenceImage, ::Google::Cloud::Vision::V1::DeleteReferenceImageRequest, ::Google::Protobuf::Empty
155
154
  # Lists reference images.
156
155
  #
157
156
  # Possible errors:
@@ -159,13 +158,13 @@ module Google
159
158
  # * Returns NOT_FOUND if the parent product does not exist.
160
159
  # * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
161
160
  # than 1.
162
- rpc :ListReferenceImages, Google::Cloud::Vision::V1::ListReferenceImagesRequest, Google::Cloud::Vision::V1::ListReferenceImagesResponse
161
+ rpc :ListReferenceImages, ::Google::Cloud::Vision::V1::ListReferenceImagesRequest, ::Google::Cloud::Vision::V1::ListReferenceImagesResponse
163
162
  # Gets information associated with a ReferenceImage.
164
163
  #
165
164
  # Possible errors:
166
165
  #
167
166
  # * Returns NOT_FOUND if the specified image does not exist.
168
- rpc :GetReferenceImage, Google::Cloud::Vision::V1::GetReferenceImageRequest, Google::Cloud::Vision::V1::ReferenceImage
167
+ rpc :GetReferenceImage, ::Google::Cloud::Vision::V1::GetReferenceImageRequest, ::Google::Cloud::Vision::V1::ReferenceImage
169
168
  # Adds a Product to the specified ProductSet. If the Product is already
170
169
  # present, no change is made.
171
170
  #
@@ -174,9 +173,9 @@ module Google
174
173
  # Possible errors:
175
174
  #
176
175
  # * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
177
- rpc :AddProductToProductSet, Google::Cloud::Vision::V1::AddProductToProductSetRequest, Google::Protobuf::Empty
176
+ rpc :AddProductToProductSet, ::Google::Cloud::Vision::V1::AddProductToProductSetRequest, ::Google::Protobuf::Empty
178
177
  # Removes a Product from the specified ProductSet.
179
- rpc :RemoveProductFromProductSet, Google::Cloud::Vision::V1::RemoveProductFromProductSetRequest, Google::Protobuf::Empty
178
+ rpc :RemoveProductFromProductSet, ::Google::Cloud::Vision::V1::RemoveProductFromProductSetRequest, ::Google::Protobuf::Empty
180
179
  # Lists the Products in a ProductSet, in an unspecified order. If the
181
180
  # ProductSet does not exist, the products field of the response will be
182
181
  # empty.
@@ -184,7 +183,7 @@ module Google
184
183
  # Possible errors:
185
184
  #
186
185
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
187
- rpc :ListProductsInProductSet, Google::Cloud::Vision::V1::ListProductsInProductSetRequest, Google::Cloud::Vision::V1::ListProductsInProductSetResponse
186
+ rpc :ListProductsInProductSet, ::Google::Cloud::Vision::V1::ListProductsInProductSetRequest, ::Google::Cloud::Vision::V1::ListProductsInProductSetResponse
188
187
  # Asynchronous API that imports a list of reference images to specified
189
188
  # product sets based on a list of image information.
190
189
  #
@@ -196,7 +195,7 @@ module Google
196
195
  # The input source of this method is a csv file on Google Cloud Storage.
197
196
  # For the format of the csv file please see
198
197
  # [ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri].
199
- rpc :ImportProductSets, Google::Cloud::Vision::V1::ImportProductSetsRequest, Google::Longrunning::Operation
198
+ rpc :ImportProductSets, ::Google::Cloud::Vision::V1::ImportProductSetsRequest, ::Google::Longrunning::Operation
200
199
  # Asynchronous API to delete all Products in a ProductSet or all Products
201
200
  # that are in no ProductSet.
202
201
  #
@@ -221,7 +220,7 @@ module Google
221
220
  # The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
222
221
  # progress and results of the request.
223
222
  # `Operation.metadata` contains `BatchOperationMetadata`. (progress)
224
- rpc :PurgeProducts, Google::Cloud::Vision::V1::PurgeProductsRequest, Google::Longrunning::Operation
223
+ rpc :PurgeProducts, ::Google::Cloud::Vision::V1::PurgeProductsRequest, ::Google::Longrunning::Operation
225
224
  end
226
225
 
227
226
  Stub = Service.rpc_stub_class
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Vision
23
23
  module V1
24
- VERSION = "0.2.5"
24
+ VERSION = "0.6.0"
25
25
  end
26
26
  end
27
27
  end
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods