google-cloud-datastore-admin-v1 0.1.1 → 0.4.1

data/lib/google/cloud/datastore/admin/v1.rb

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

data/lib/google/cloud/datastore/admin/v1/datastore_admin/client.rb

@@ -119,7 +119,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
@@ -128,20 +128,24 @@ module Google
 
                   default_config.rpcs.import_entities.timeout = 60.0
 
+                  default_config.rpcs.create_index.timeout = 60.0
+
+                  default_config.rpcs.delete_index.timeout = 60.0
+
                   default_config.rpcs.get_index.timeout = 60.0
                   default_config.rpcs.get_index.retry_policy = {
                     initial_delay: 0.1,
-                    max_delay:     60.0,
-                    multiplier:    1.3,
-                    retry_codes:   [14, 4]
+                max_delay: 60.0,
+                multiplier: 1.3,
+                retry_codes: [14, 4]
                   }
 
                   default_config.rpcs.list_indexes.timeout = 60.0
                   default_config.rpcs.list_indexes.retry_policy = {
                     initial_delay: 0.1,
-                    max_delay:     60.0,
-                    multiplier:    1.3,
-                    retry_codes:   [14, 4]
+                max_delay: 60.0,
+                multiplier: 1.3,
+                retry_codes: [14, 4]
                   }
 
                   default_config
@@ -205,7 +209,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
@@ -424,6 +434,168 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Creates the specified index.
+              # A newly created index's initial state is `CREATING`. On completion of the
+              # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the state will be `READY`.
+              # If the index already exists, the call will return an `ALREADY_EXISTS`
+              # status.
+              #
+              # During index creation, the process could result in an error, in which
+              # case the index will move to the `ERROR` state. The process can be recovered
+              # by fixing the data that caused the error, removing the index with
+              # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#delete_index delete}, then
+              # re-creating the index with [create]
+              # [google.datastore.admin.v1.DatastoreAdmin.CreateIndex].
+              #
+              # Indexes with a single property cannot be created.
+              #
+              # @overload create_index(request, options = nil)
+              #   Pass arguments to `create_index` via a request object, either of type
+              #   {::Google::Cloud::Datastore::Admin::V1::CreateIndexRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Datastore::Admin::V1::CreateIndexRequest, ::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 create_index(project_id: nil, index: nil)
+              #   Pass arguments to `create_index` 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 project_id [::String]
+              #     Project ID against which to make the request.
+              #   @param index [::Google::Cloud::Datastore::Admin::V1::Index, ::Hash]
+              #     The index to create. The name and state fields are output only and will be
+              #     ignored. Single property indexes cannot be created or deleted.
+              #
+              # @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 create_index request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastore::Admin::V1::CreateIndexRequest
+
+                # 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.create_index.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::Datastore::Admin::V1::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {
+                  "project_id" => request.project_id
+                }
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.create_index.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.create_index.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @datastore_admin_stub.call_rpc :create_index, 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
+
+              ##
+              # Deletes an existing index.
+              # An index can only be deleted if it is in a `READY` or `ERROR` state. On
+              # successful execution of the request, the index will be in a `DELETING`
+              # {::Google::Cloud::Datastore::Admin::V1::Index::State state}. And on completion of the
+              # returned {::Google::Longrunning::Operation google.longrunning.Operation}, the index will be removed.
+              #
+              # During index deletion, the process could result in an error, in which
+              # case the index will move to the `ERROR` state. The process can be recovered
+              # by fixing the data that caused the error, followed by calling
+              # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#delete_index delete} again.
+              #
+              # @overload delete_index(request, options = nil)
+              #   Pass arguments to `delete_index` via a request object, either of type
+              #   {::Google::Cloud::Datastore::Admin::V1::DeleteIndexRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Datastore::Admin::V1::DeleteIndexRequest, ::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 delete_index(project_id: nil, index_id: nil)
+              #   Pass arguments to `delete_index` 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 project_id [::String]
+              #     Project ID against which to make the request.
+              #   @param index_id [::String]
+              #     The resource ID of the index to delete.
+              #
+              # @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 delete_index request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastore::Admin::V1::DeleteIndexRequest
+
+                # 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.delete_index.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::Datastore::Admin::V1::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {
+                  "project_id" => request.project_id,
+                  "index_id" => request.index_id
+                }
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.delete_index.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.delete_index.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @datastore_admin_stub.call_rpc :delete_index, 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
+
               ##
               # Gets an index.
               #
@@ -474,7 +646,7 @@ module Google
 
                 header_params = {
                   "project_id" => request.project_id,
-                  "index_id"   => request.index_id
+                  "index_id" => request.index_id
                 }
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
@@ -660,7 +832,7 @@ module Google
                 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
@@ -681,7 +853,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
@@ -693,7 +865,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:
@@ -715,6 +887,16 @@ module Google
                   #
                   attr_reader :import_entities
                   ##
+                  # RPC-specific configuration for `create_index`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :create_index
+                  ##
+                  # RPC-specific configuration for `delete_index`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :delete_index
+                  ##
                   # RPC-specific configuration for `get_index`
                   # @return [::Gapic::Config::Method]
                   #
@@ -727,13 +909,17 @@ module Google
 
                   # @private
                   def initialize parent_rpcs = nil
-                    export_entities_config = parent_rpcs&.export_entities if parent_rpcs&.respond_to? :export_entities
+                    export_entities_config = parent_rpcs.export_entities if parent_rpcs.respond_to? :export_entities
                     @export_entities = ::Gapic::Config::Method.new export_entities_config
-                    import_entities_config = parent_rpcs&.import_entities if parent_rpcs&.respond_to? :import_entities
+                    import_entities_config = parent_rpcs.import_entities if parent_rpcs.respond_to? :import_entities
                     @import_entities = ::Gapic::Config::Method.new import_entities_config
-                    get_index_config = parent_rpcs&.get_index if parent_rpcs&.respond_to? :get_index
+                    create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
+                    @create_index = ::Gapic::Config::Method.new create_index_config
+                    delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
+                    @delete_index = ::Gapic::Config::Method.new delete_index_config
+                    get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
                     @get_index = ::Gapic::Config::Method.new get_index_config
-                    list_indexes_config = parent_rpcs&.list_indexes if parent_rpcs&.respond_to? :list_indexes
+                    list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
                     @list_indexes = ::Gapic::Config::Method.new list_indexes_config
 
                     yield self if block_given?

data/lib/google/cloud/datastore/admin/v1/datastore_admin/operations.rb

@@ -104,8 +104,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
@@ -123,7 +128,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]
@@ -391,6 +396,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::Datastore::Admin::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.
               #
@@ -483,7 +561,7 @@ module Google
                 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
@@ -504,7 +582,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
@@ -516,7 +594,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:
@@ -547,17 +625,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