google-cloud-spanner-admin-instance-v1 0.1.2 → 0.3.1

data/lib/google/cloud/spanner/admin/instance/v1.rb

@@ -37,3 +37,6 @@ module Google
     end
   end
 end
+
+helper_path = ::File.join __dir__, "v1", "_helpers.rb"
+require "google/cloud/spanner/admin/instance/v1/_helpers" if ::File.file? helper_path

data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb

@@ -82,7 +82,7 @@ module Google
                     parent_config = while namespace.any?
                                       parent_name = namespace.join "::"
                                       parent_const = const_get parent_name
-                                      break parent_const.configure if parent_const&.respond_to? :configure
+                                      break parent_const.configure if parent_const.respond_to? :configure
                                       namespace.pop
                                     end
                     default_config = Client::Configuration.new parent_config
@@ -90,33 +90,33 @@ module Google
                     default_config.rpcs.list_instance_configs.timeout = 3600.0
                     default_config.rpcs.list_instance_configs.retry_policy = {
                       initial_delay: 1.0,
-                      max_delay:     32.0,
-                      multiplier:    1.3,
-                      retry_codes:   [14, 4]
+                  max_delay: 32.0,
+                  multiplier: 1.3,
+                  retry_codes: [14, 4]
                     }
 
                     default_config.rpcs.get_instance_config.timeout = 3600.0
                     default_config.rpcs.get_instance_config.retry_policy = {
                       initial_delay: 1.0,
-                      max_delay:     32.0,
-                      multiplier:    1.3,
-                      retry_codes:   [14, 4]
+                  max_delay: 32.0,
+                  multiplier: 1.3,
+                  retry_codes: [14, 4]
                     }
 
                     default_config.rpcs.list_instances.timeout = 3600.0
                     default_config.rpcs.list_instances.retry_policy = {
                       initial_delay: 1.0,
-                      max_delay:     32.0,
-                      multiplier:    1.3,
-                      retry_codes:   [14, 4]
+                  max_delay: 32.0,
+                  multiplier: 1.3,
+                  retry_codes: [14, 4]
                     }
 
                     default_config.rpcs.get_instance.timeout = 3600.0
                     default_config.rpcs.get_instance.retry_policy = {
                       initial_delay: 1.0,
-                      max_delay:     32.0,
-                      multiplier:    1.3,
-                      retry_codes:   [14, 4]
+                  max_delay: 32.0,
+                  multiplier: 1.3,
+                  retry_codes: [14, 4]
                     }
 
                     default_config.rpcs.create_instance.timeout = 3600.0
@@ -126,9 +126,9 @@ module Google
                     default_config.rpcs.delete_instance.timeout = 3600.0
                     default_config.rpcs.delete_instance.retry_policy = {
                       initial_delay: 1.0,
-                      max_delay:     32.0,
-                      multiplier:    1.3,
-                      retry_codes:   [14, 4]
+                  max_delay: 32.0,
+                  multiplier: 1.3,
+                  retry_codes: [14, 4]
                     }
 
                     default_config.rpcs.set_iam_policy.timeout = 30.0
@@ -136,9 +136,9 @@ module Google
                     default_config.rpcs.get_iam_policy.timeout = 30.0
                     default_config.rpcs.get_iam_policy.retry_policy = {
                       initial_delay: 1.0,
-                      max_delay:     32.0,
-                      multiplier:    1.3,
-                      retry_codes:   [14, 4]
+                  max_delay: 32.0,
+                  multiplier: 1.3,
+                  retry_codes: [14, 4]
                     }
 
                     default_config.rpcs.test_iam_permissions.timeout = 30.0
@@ -204,7 +204,13 @@ module Google
 
                   # Create credentials
                   credentials = @config.credentials
-                  credentials ||= Credentials.default scope: @config.scope
+                  # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                  # but only if the default endpoint does not have a region prefix.
+                  enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                           @config.endpoint == Client.configure.endpoint &&
+                                           !@config.endpoint.split(".").first.include?("-")
+                  credentials ||= Credentials.default scope: @config.scope,
+                                                      enable_self_signed_jwt: enable_self_signed_jwt
                   if credentials.is_a?(String) || credentials.is_a?(Hash)
                     credentials = Credentials.new credentials, scope: @config.scope
                   end
@@ -1152,14 +1158,14 @@ module Google
 
                   config_attr :endpoint,      "spanner.googleapis.com", ::String
                   config_attr :credentials,   nil do |value|
-                    allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                     allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                     allowed.any? { |klass| klass === value }
                   end
                   config_attr :scope,         nil, ::String, ::Array, nil
                   config_attr :lib_name,      nil, ::String, nil
                   config_attr :lib_version,   nil, ::String, nil
-                  config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+                  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
                   config_attr :interceptors,  nil, ::Array, nil
                   config_attr :timeout,       nil, ::Numeric, nil
                   config_attr :metadata,      nil, ::Hash, nil
@@ -1180,7 +1186,7 @@ module Google
                   def rpcs
                     @rpcs ||= begin
                       parent_rpcs = nil
-                      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                       Rpcs.new parent_rpcs
                     end
                   end
@@ -1192,7 +1198,7 @@ module Google
                   # Each configuration object is of type `Gapic::Config::Method` and includes
                   # the following configuration fields:
                   #
-                  #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+                  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
                   #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
                   #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
                   #     include the following keys:
@@ -1256,25 +1262,25 @@ module Google
 
                     # @private
                     def initialize parent_rpcs = nil
-                      list_instance_configs_config = parent_rpcs&.list_instance_configs if parent_rpcs&.respond_to? :list_instance_configs
+                      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
                       @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
-                      get_instance_config_config = parent_rpcs&.get_instance_config if parent_rpcs&.respond_to? :get_instance_config
+                      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
                       @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
-                      list_instances_config = parent_rpcs&.list_instances if parent_rpcs&.respond_to? :list_instances
+                      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
                       @list_instances = ::Gapic::Config::Method.new list_instances_config
-                      get_instance_config = parent_rpcs&.get_instance if parent_rpcs&.respond_to? :get_instance
+                      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
                       @get_instance = ::Gapic::Config::Method.new get_instance_config
-                      create_instance_config = parent_rpcs&.create_instance if parent_rpcs&.respond_to? :create_instance
+                      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
                       @create_instance = ::Gapic::Config::Method.new create_instance_config
-                      update_instance_config = parent_rpcs&.update_instance if parent_rpcs&.respond_to? :update_instance
+                      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
                       @update_instance = ::Gapic::Config::Method.new update_instance_config
-                      delete_instance_config = parent_rpcs&.delete_instance if parent_rpcs&.respond_to? :delete_instance
+                      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
                       @delete_instance = ::Gapic::Config::Method.new delete_instance_config
-                      set_iam_policy_config = parent_rpcs&.set_iam_policy if parent_rpcs&.respond_to? :set_iam_policy
+                      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
                       @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
-                      get_iam_policy_config = parent_rpcs&.get_iam_policy if parent_rpcs&.respond_to? :get_iam_policy
+                      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
                       @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
-                      test_iam_permissions_config = parent_rpcs&.test_iam_permissions if parent_rpcs&.respond_to? :test_iam_permissions
+                      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
                       @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
 
                       yield self if block_given?

data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/operations.rb

@@ -105,8 +105,13 @@ module Google
                 # Lists operations that match the specified filter in the request. If the
                 # server doesn't support this method, it returns `UNIMPLEMENTED`.
                 #
-                # NOTE: the `name` binding below allows API services to override the binding
-                # to use different resource name schemes, such as `users/*/operations`.
+                # NOTE: the `name` binding allows API services to override the binding
+                # to use different resource name schemes, such as `users/*/operations`. To
+                # override the binding, API services can add a binding such as
+                # `"/v1/{name=users/*}/operations"` to their service configuration.
+                # For backwards compatibility, the default name includes the operations
+                # collection id, however overriding users must ensure the name binding
+                # is the parent resource, without the operations collection id.
                 #
                 # @overload list_operations(request, options = nil)
                 #   Pass arguments to `list_operations` via a request object, either of type
@@ -124,7 +129,7 @@ module Google
                 #   the default parameter values, pass an empty Hash as a request object (see above).
                 #
                 #   @param name [::String]
-                #     The name of the operation collection.
+                #     The name of the operation's parent resource.
                 #   @param filter [::String]
                 #     The standard list filter.
                 #   @param page_size [::Integer]
@@ -392,6 +397,79 @@ module Google
                   raise ::Google::Cloud::Error.from_error(e)
                 end
 
+                ##
+                # Waits for the specified long-running operation until it is done or reaches
+                # at most a specified timeout, returning the latest state.  If the operation
+                # is already done, the latest state is immediately returned.  If the timeout
+                # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+                # timeout is used.  If the server does not support this method, it returns
+                # `google.rpc.Code.UNIMPLEMENTED`.
+                # Note that this method is on a best-effort basis.  It may return the latest
+                # state before the specified timeout (including immediately), meaning even an
+                # immediate response is no guarantee that the operation is done.
+                #
+                # @overload wait_operation(request, options = nil)
+                #   Pass arguments to `wait_operation` via a request object, either of type
+                #   {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
+                #
+                #   @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
+                #     A request object representing the call parameters. Required. To specify no
+                #     parameters, or to keep all the default parameter values, pass an empty Hash.
+                #   @param options [::Gapic::CallOptions, ::Hash]
+                #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+                #
+                # @overload wait_operation(name: nil, timeout: nil)
+                #   Pass arguments to `wait_operation` via keyword arguments. Note that at
+                #   least one keyword argument is required. To specify no parameters, or to keep all
+                #   the default parameter values, pass an empty Hash as a request object (see above).
+                #
+                #   @param name [::String]
+                #     The name of the operation resource to wait on.
+                #   @param timeout [::Google::Protobuf::Duration, ::Hash]
+                #     The maximum duration to wait before timing out. If left blank, the wait
+                #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+                #     If RPC context deadline is also specified, the shorter one will be used.
+                #
+                # @yield [response, operation] Access the result along with the RPC operation
+                # @yieldparam response [::Gapic::Operation]
+                # @yieldparam operation [::GRPC::ActiveCall::Operation]
+                #
+                # @return [::Gapic::Operation]
+                #
+                # @raise [::Google::Cloud::Error] if the RPC is aborted.
+                #
+                def wait_operation request, options = nil
+                  raise ::ArgumentError, "request must be provided" if request.nil?
+
+                  request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
+
+                  # Converts hash and nil to an options object
+                  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                  # Customize the options with defaults
+                  metadata = @config.rpcs.wait_operation.metadata.to_h
+
+                  # Set x-goog-api-client and x-goog-user-project headers
+                  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                    lib_name: @config.lib_name, lib_version: @config.lib_version,
+                    gapic_version: ::Google::Cloud::Spanner::Admin::Instance::V1::VERSION
+                  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                  options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
+                                         metadata:     metadata,
+                                         retry_policy: @config.rpcs.wait_operation.retry_policy
+                  options.apply_defaults metadata:     @config.metadata,
+                                         retry_policy: @config.retry_policy
+
+                  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
+                    response = ::Gapic::Operation.new response, @operations_client, options: options
+                    yield response, operation if block_given?
+                    return response
+                  end
+                rescue ::GRPC::BadStatus => e
+                  raise ::Google::Cloud::Error.from_error(e)
+                end
+
                 ##
                 # Configuration class for the Operations API.
                 #
@@ -477,14 +555,14 @@ module Google
 
                   config_attr :endpoint,      "spanner.googleapis.com", ::String
                   config_attr :credentials,   nil do |value|
-                    allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                     allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                     allowed.any? { |klass| klass === value }
                   end
                   config_attr :scope,         nil, ::String, ::Array, nil
                   config_attr :lib_name,      nil, ::String, nil
                   config_attr :lib_version,   nil, ::String, nil
-                  config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+                  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
                   config_attr :interceptors,  nil, ::Array, nil
                   config_attr :timeout,       nil, ::Numeric, nil
                   config_attr :metadata,      nil, ::Hash, nil
@@ -505,7 +583,7 @@ module Google
                   def rpcs
                     @rpcs ||= begin
                       parent_rpcs = nil
-                      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                       Rpcs.new parent_rpcs
                     end
                   end
@@ -517,7 +595,7 @@ module Google
                   # Each configuration object is of type `Gapic::Config::Method` and includes
                   # the following configuration fields:
                   #
-                  #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+                  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
                   #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
                   #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
                   #     include the following keys:
@@ -548,17 +626,24 @@ module Google
                     # @return [::Gapic::Config::Method]
                     #
                     attr_reader :cancel_operation
+                    ##
+                    # RPC-specific configuration for `wait_operation`
+                    # @return [::Gapic::Config::Method]
+                    #
+                    attr_reader :wait_operation
 
                     # @private
                     def initialize parent_rpcs = nil
-                      list_operations_config = parent_rpcs&.list_operations if parent_rpcs&.respond_to? :list_operations
+                      list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
                       @list_operations = ::Gapic::Config::Method.new list_operations_config
-                      get_operation_config = parent_rpcs&.get_operation if parent_rpcs&.respond_to? :get_operation
+                      get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
                       @get_operation = ::Gapic::Config::Method.new get_operation_config
-                      delete_operation_config = parent_rpcs&.delete_operation if parent_rpcs&.respond_to? :delete_operation
+                      delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
                       @delete_operation = ::Gapic::Config::Method.new delete_operation_config
-                      cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
+                      cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
                       @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
+                      wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
+                      @wait_operation = ::Gapic::Config::Method.new wait_operation_config
 
                       yield self if block_given?
                     end

data/lib/google/cloud/spanner/admin/instance/v1/version.rb

@@ -23,7 +23,7 @@ module Google
       module Admin
         module Instance
           module V1
-            VERSION = "0.1.2"
+            VERSION = "0.3.1"
           end
         end
       end

data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb

@@ -56,13 +56,13 @@ module Google
                 self.service_name = 'google.spanner.admin.instance.v1.InstanceAdmin'
 
                 # Lists the supported instance configurations for a given project.
-                rpc :ListInstanceConfigs, Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest, Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse
+                rpc :ListInstanceConfigs, ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest, ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse
                 # Gets information about a particular instance configuration.
-                rpc :GetInstanceConfig, Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceConfigRequest, Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig
+                rpc :GetInstanceConfig, ::Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceConfigRequest, ::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig
                 # Lists all instances in the given project.
-                rpc :ListInstances, Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesRequest, Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse
+                rpc :ListInstances, ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesRequest, ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse
                 # Gets information about a particular instance.
-                rpc :GetInstance, Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceRequest, Google::Cloud::Spanner::Admin::Instance::V1::Instance
+                rpc :GetInstance, ::Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceRequest, ::Google::Cloud::Spanner::Admin::Instance::V1::Instance
                 # Creates an instance and begins preparing it to begin serving. The
                 # returned [long-running operation][google.longrunning.Operation]
                 # can be used to track the progress of preparing the new
@@ -97,7 +97,7 @@ module Google
                 # [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata].
                 # The [response][google.longrunning.Operation.response] field type is
                 # [Instance][google.spanner.admin.instance.v1.Instance], if successful.
-                rpc :CreateInstance, Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceRequest, Google::Longrunning::Operation
+                rpc :CreateInstance, ::Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceRequest, ::Google::Longrunning::Operation
                 # Updates an instance, and begins allocating or releasing resources
                 # as requested. The returned [long-running
                 # operation][google.longrunning.Operation] can be used to track the
@@ -138,7 +138,7 @@ module Google
                 #
                 # Authorization requires `spanner.instances.update` permission on
                 # resource [name][google.spanner.admin.instance.v1.Instance.name].
-                rpc :UpdateInstance, Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceRequest, Google::Longrunning::Operation
+                rpc :UpdateInstance, ::Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceRequest, ::Google::Longrunning::Operation
                 # Deletes an instance.
                 #
                 # Immediately upon completion of the request:
@@ -150,26 +150,26 @@ module Google
                 #   * The instance and *all of its databases* immediately and
                 #     irrevocably disappear from the API. All data in the databases
                 #     is permanently deleted.
-                rpc :DeleteInstance, Google::Cloud::Spanner::Admin::Instance::V1::DeleteInstanceRequest, Google::Protobuf::Empty
+                rpc :DeleteInstance, ::Google::Cloud::Spanner::Admin::Instance::V1::DeleteInstanceRequest, ::Google::Protobuf::Empty
                 # Sets the access control policy on an instance resource. Replaces any
                 # existing policy.
                 #
                 # Authorization requires `spanner.instances.setIamPolicy` on
                 # [resource][google.iam.v1.SetIamPolicyRequest.resource].
-                rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
+                rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
                 # Gets the access control policy for an instance resource. Returns an empty
                 # policy if an instance exists but does not have a policy set.
                 #
                 # Authorization requires `spanner.instances.getIamPolicy` on
                 # [resource][google.iam.v1.GetIamPolicyRequest.resource].
-                rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
+                rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
                 # Returns permissions that the caller has on the specified instance resource.
                 #
                 # Attempting this RPC on a non-existent Cloud Spanner instance resource will
                 # result in a NOT_FOUND error if the user has `spanner.instances.list`
                 # permission on the containing Google Cloud Project. Otherwise returns an
                 # empty set of permissions.
-                rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
+                rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
               end
 
               Stub = Service.rpc_stub_class

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods