google-cloud-functions-v1 0.1.0 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -33,3 +33,6 @@ module Google
33
33
  end
34
34
  end
35
35
  end
36
+
37
+ helper_path = ::File.join __dir__, "v1", "_helpers.rb"
38
+ require "google/cloud/functions/v1/_helpers" if ::File.file? helper_path
@@ -60,11 +60,35 @@ module Google
60
60
  parent_config = while namespace.any?
61
61
  parent_name = namespace.join "::"
62
62
  parent_const = const_get parent_name
63
- break parent_const.configure if parent_const&.respond_to? :configure
63
+ break parent_const.configure if parent_const.respond_to? :configure
64
64
  namespace.pop
65
65
  end
66
66
  default_config = Client::Configuration.new parent_config
67
67
 
68
+ default_config.rpcs.list_functions.timeout = 600.0
69
+ default_config.rpcs.list_functions.retry_policy = {
70
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
71
+ }
72
+
73
+ default_config.rpcs.get_function.timeout = 600.0
74
+ default_config.rpcs.get_function.retry_policy = {
75
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
76
+ }
77
+
78
+ default_config.rpcs.create_function.timeout = 600.0
79
+
80
+ default_config.rpcs.update_function.timeout = 600.0
81
+ default_config.rpcs.update_function.retry_policy = {
82
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
83
+ }
84
+
85
+ default_config.rpcs.delete_function.timeout = 600.0
86
+ default_config.rpcs.delete_function.retry_policy = {
87
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
88
+ }
89
+
90
+ default_config.rpcs.call_function.timeout = 600.0
91
+
68
92
  default_config
69
93
  end
70
94
  yield @configure if block_given?
@@ -126,8 +150,14 @@ module Google
126
150
 
127
151
  # Create credentials
128
152
  credentials = @config.credentials
129
- credentials ||= Credentials.default scope: @config.scope
130
- if credentials.is_a?(String) || credentials.is_a?(Hash)
153
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
154
+ # but only if the default endpoint does not have a region prefix.
155
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
156
+ @config.endpoint == Client.configure.endpoint &&
157
+ !@config.endpoint.split(".").first.include?("-")
158
+ credentials ||= Credentials.default scope: @config.scope,
159
+ enable_self_signed_jwt: enable_self_signed_jwt
160
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
131
161
  credentials = Credentials.new credentials, scope: @config.scope
132
162
  end
133
163
  @quota_project_id = @config.quota_project
@@ -1059,7 +1089,7 @@ module Google
1059
1089
  config_attr :scope, nil, ::String, ::Array, nil
1060
1090
  config_attr :lib_name, nil, ::String, nil
1061
1091
  config_attr :lib_version, nil, ::String, nil
1062
- config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
1092
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
1063
1093
  config_attr :interceptors, nil, ::Array, nil
1064
1094
  config_attr :timeout, nil, ::Numeric, nil
1065
1095
  config_attr :metadata, nil, ::Hash, nil
@@ -1080,7 +1110,7 @@ module Google
1080
1110
  def rpcs
1081
1111
  @rpcs ||= begin
1082
1112
  parent_rpcs = nil
1083
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
1113
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
1084
1114
  Rpcs.new parent_rpcs
1085
1115
  end
1086
1116
  end
@@ -1092,7 +1122,7 @@ module Google
1092
1122
  # Each configuration object is of type `Gapic::Config::Method` and includes
1093
1123
  # the following configuration fields:
1094
1124
  #
1095
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
1125
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
1096
1126
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
1097
1127
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
1098
1128
  # include the following keys:
@@ -1161,27 +1191,27 @@ module Google
1161
1191
 
1162
1192
  # @private
1163
1193
  def initialize parent_rpcs = nil
1164
- list_functions_config = parent_rpcs&.list_functions if parent_rpcs&.respond_to? :list_functions
1194
+ list_functions_config = parent_rpcs.list_functions if parent_rpcs.respond_to? :list_functions
1165
1195
  @list_functions = ::Gapic::Config::Method.new list_functions_config
1166
- get_function_config = parent_rpcs&.get_function if parent_rpcs&.respond_to? :get_function
1196
+ get_function_config = parent_rpcs.get_function if parent_rpcs.respond_to? :get_function
1167
1197
  @get_function = ::Gapic::Config::Method.new get_function_config
1168
- create_function_config = parent_rpcs&.create_function if parent_rpcs&.respond_to? :create_function
1198
+ create_function_config = parent_rpcs.create_function if parent_rpcs.respond_to? :create_function
1169
1199
  @create_function = ::Gapic::Config::Method.new create_function_config
1170
- update_function_config = parent_rpcs&.update_function if parent_rpcs&.respond_to? :update_function
1200
+ update_function_config = parent_rpcs.update_function if parent_rpcs.respond_to? :update_function
1171
1201
  @update_function = ::Gapic::Config::Method.new update_function_config
1172
- delete_function_config = parent_rpcs&.delete_function if parent_rpcs&.respond_to? :delete_function
1202
+ delete_function_config = parent_rpcs.delete_function if parent_rpcs.respond_to? :delete_function
1173
1203
  @delete_function = ::Gapic::Config::Method.new delete_function_config
1174
- call_function_config = parent_rpcs&.call_function if parent_rpcs&.respond_to? :call_function
1204
+ call_function_config = parent_rpcs.call_function if parent_rpcs.respond_to? :call_function
1175
1205
  @call_function = ::Gapic::Config::Method.new call_function_config
1176
- generate_upload_url_config = parent_rpcs&.generate_upload_url if parent_rpcs&.respond_to? :generate_upload_url
1206
+ generate_upload_url_config = parent_rpcs.generate_upload_url if parent_rpcs.respond_to? :generate_upload_url
1177
1207
  @generate_upload_url = ::Gapic::Config::Method.new generate_upload_url_config
1178
- generate_download_url_config = parent_rpcs&.generate_download_url if parent_rpcs&.respond_to? :generate_download_url
1208
+ generate_download_url_config = parent_rpcs.generate_download_url if parent_rpcs.respond_to? :generate_download_url
1179
1209
  @generate_download_url = ::Gapic::Config::Method.new generate_download_url_config
1180
- set_iam_policy_config = parent_rpcs&.set_iam_policy if parent_rpcs&.respond_to? :set_iam_policy
1210
+ set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
1181
1211
  @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
1182
- get_iam_policy_config = parent_rpcs&.get_iam_policy if parent_rpcs&.respond_to? :get_iam_policy
1212
+ get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
1183
1213
  @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
1184
- test_iam_permissions_config = parent_rpcs&.test_iam_permissions if parent_rpcs&.respond_to? :test_iam_permissions
1214
+ test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
1185
1215
  @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
1186
1216
 
1187
1217
  yield self if block_given?
@@ -82,7 +82,7 @@ module Google
82
82
  # Create credentials
83
83
  credentials = @config.credentials
84
84
  credentials ||= Credentials.default scope: @config.scope
85
- if credentials.is_a?(String) || credentials.is_a?(Hash)
85
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
86
86
  credentials = Credentials.new credentials, scope: @config.scope
87
87
  end
88
88
  @quota_project_id = @config.quota_project
@@ -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 until the specified long-running operation is done or reaches at most
400
+ # a specified timeout, returning the latest state. If the operation is
401
+ # 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::Functions::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
@@ -34,24 +34,24 @@ module Google
34
34
  self.service_name = 'google.cloud.functions.v1.CloudFunctionsService'
35
35
 
36
36
  # Returns a list of functions that belong to the requested project.
37
- rpc :ListFunctions, Google::Cloud::Functions::V1::ListFunctionsRequest, Google::Cloud::Functions::V1::ListFunctionsResponse
37
+ rpc :ListFunctions, ::Google::Cloud::Functions::V1::ListFunctionsRequest, ::Google::Cloud::Functions::V1::ListFunctionsResponse
38
38
  # Returns a function with the given name from the requested project.
39
- rpc :GetFunction, Google::Cloud::Functions::V1::GetFunctionRequest, Google::Cloud::Functions::V1::CloudFunction
39
+ rpc :GetFunction, ::Google::Cloud::Functions::V1::GetFunctionRequest, ::Google::Cloud::Functions::V1::CloudFunction
40
40
  # Creates a new function. If a function with the given name already exists in
41
41
  # the specified project, the long running operation will return
42
42
  # `ALREADY_EXISTS` error.
43
- rpc :CreateFunction, Google::Cloud::Functions::V1::CreateFunctionRequest, Google::Longrunning::Operation
43
+ rpc :CreateFunction, ::Google::Cloud::Functions::V1::CreateFunctionRequest, ::Google::Longrunning::Operation
44
44
  # Updates existing function.
45
- rpc :UpdateFunction, Google::Cloud::Functions::V1::UpdateFunctionRequest, Google::Longrunning::Operation
45
+ rpc :UpdateFunction, ::Google::Cloud::Functions::V1::UpdateFunctionRequest, ::Google::Longrunning::Operation
46
46
  # Deletes a function with the given name from the specified project. If the
47
47
  # given function is used by some trigger, the trigger will be updated to
48
48
  # remove this function.
49
- rpc :DeleteFunction, Google::Cloud::Functions::V1::DeleteFunctionRequest, Google::Longrunning::Operation
49
+ rpc :DeleteFunction, ::Google::Cloud::Functions::V1::DeleteFunctionRequest, ::Google::Longrunning::Operation
50
50
  # Synchronously invokes a deployed Cloud Function. To be used for testing
51
51
  # purposes as very limited traffic is allowed. For more information on
52
52
  # the actual limits, refer to
53
53
  # [Rate Limits](https://cloud.google.com/functions/quotas#rate_limits).
54
- rpc :CallFunction, Google::Cloud::Functions::V1::CallFunctionRequest, Google::Cloud::Functions::V1::CallFunctionResponse
54
+ rpc :CallFunction, ::Google::Cloud::Functions::V1::CallFunctionRequest, ::Google::Cloud::Functions::V1::CallFunctionResponse
55
55
  # Returns a signed URL for uploading a function source code.
56
56
  # For more information about the signed URL usage see:
57
57
  # https://cloud.google.com/storage/docs/access-control/signed-urls.
@@ -77,25 +77,25 @@ module Google
77
77
  # And this header SHOULD NOT be specified:
78
78
  #
79
79
  # * `Authorization: Bearer YOUR_TOKEN`
80
- rpc :GenerateUploadUrl, Google::Cloud::Functions::V1::GenerateUploadUrlRequest, Google::Cloud::Functions::V1::GenerateUploadUrlResponse
80
+ rpc :GenerateUploadUrl, ::Google::Cloud::Functions::V1::GenerateUploadUrlRequest, ::Google::Cloud::Functions::V1::GenerateUploadUrlResponse
81
81
  # Returns a signed URL for downloading deployed function source code.
82
82
  # The URL is only valid for a limited period and should be used within
83
83
  # minutes after generation.
84
84
  # For more information about the signed URL usage see:
85
85
  # https://cloud.google.com/storage/docs/access-control/signed-urls
86
- rpc :GenerateDownloadUrl, Google::Cloud::Functions::V1::GenerateDownloadUrlRequest, Google::Cloud::Functions::V1::GenerateDownloadUrlResponse
86
+ rpc :GenerateDownloadUrl, ::Google::Cloud::Functions::V1::GenerateDownloadUrlRequest, ::Google::Cloud::Functions::V1::GenerateDownloadUrlResponse
87
87
  # Sets the IAM access control policy on the specified function.
88
88
  # Replaces any existing policy.
89
- rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
89
+ rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
90
90
  # Gets the IAM access control policy for a function.
91
91
  # Returns an empty policy if the function exists and does not have a policy
92
92
  # set.
93
- rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
93
+ rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
94
94
  # Tests the specified permissions against the IAM access control policy
95
95
  # for a function.
96
96
  # If the function does not exist, this will return an empty set of
97
97
  # permissions, not a NOT_FOUND error.
98
- rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
98
+ rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
99
99
  end
100
100
 
101
101
  Stub = Service.rpc_stub_class
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Functions
23
23
  module V1
24
- VERSION = "0.1.0"
24
+ VERSION = "0.3.2"
25
25
  end
26
26
  end
27
27
  end
@@ -54,6 +54,18 @@ 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
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
57
69
  end
58
70
  end
59
71
  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