google-cloud-datastore-admin-v1 0.1.0

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/datastore/admin/v1"

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/datastore/admin/v1/datastore_admin"
+require "google/cloud/datastore/admin/v1/version"
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        ##
+        # To load this package, including all its services, and instantiate a client:
+        #
+        #     require "google/cloud/datastore/admin/v1"
+        #     client = ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client.new
+        #
+        module V1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/datastore/admin/v1/version"
+
+require "google/cloud/datastore/admin/v1/datastore_admin/credentials"
+require "google/cloud/datastore/admin/v1/datastore_admin/operations"
+require "google/cloud/datastore/admin/v1/datastore_admin/client"
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        module V1
+          ##
+          # Google Cloud Datastore Admin API
+          #
+          #
+          # The Datastore Admin API provides several admin services for Cloud Datastore.
+          #
+          # -----------------------------------------------------------------------------
+          # ## Concepts
+          #
+          # Project, namespace, kind, and entity as defined in the Google Cloud Datastore
+          # API.
+          #
+          # Operation: An Operation represents work being performed in the background.
+          #
+          # EntityFilter: Allows specifying a subset of entities in a project. This is
+          # specified as a combination of kinds and namespaces (either or both of which
+          # may be all).
+          #
+          # -----------------------------------------------------------------------------
+          # ## Services
+          #
+          # # Export/Import
+          #
+          # The Export/Import service provides the ability to copy all or a subset of
+          # entities to/from Google Cloud Storage.
+          #
+          # Exported data may be imported into Cloud Datastore for any Google Cloud
+          # Platform project. It is not restricted to the export source project. It is
+          # possible to export from one project and then import into another.
+          #
+          # Exported data can also be loaded into Google BigQuery for analysis.
+          #
+          # Exports and imports are performed asynchronously. An Operation resource is
+          # created for each export/import. The state (including any errors encountered)
+          # of the export/import may be queried via the Operation resource.
+          #
+          # # Index
+          #
+          # The index service manages Cloud Datastore composite indexes.
+          #
+          # Index creation and deletion are performed asynchronously.
+          # An Operation resource is created for each such asynchronous operation.
+          # The state of the operation (including any errors encountered)
+          # may be queried via the Operation resource.
+          #
+          # # Operation
+          #
+          # The Operations collection provides a record of actions performed for the
+          # specified project (including any operations in progress). Operations are not
+          # created directly but through calls on other collections or resources.
+          #
+          # An operation that is not yet done may be cancelled. The request to cancel is
+          # asynchronous and the operation may continue to run for some time after the
+          # request to cancel is made.
+          #
+          # An operation that is done may be deleted so that it is no longer listed as
+          # part of the Operation collection.
+          #
+          # ListOperations returns all pending operations, but not completed operations.
+          #
+          # Operations are created by service DatastoreAdmin,
+          # but are accessed via service google.longrunning.Operations.
+          #
+          # To load this service and instantiate a client:
+          #
+          #     require "google/cloud/datastore/admin/v1/datastore_admin"
+          #     client = ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client.new
+          #
+          module DatastoreAdmin
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "datastore_admin", "helpers.rb"
+require "google/cloud/datastore/admin/v1/datastore_admin/helpers" if ::File.file? helper_path

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

@@ -0,0 +1,749 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/errors"
+require "google/datastore/admin/v1/datastore_admin_pb"
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        module V1
+          module DatastoreAdmin
+            ##
+            # Client for the DatastoreAdmin service.
+            #
+            # Google Cloud Datastore Admin API
+            #
+            #
+            # The Datastore Admin API provides several admin services for Cloud Datastore.
+            #
+            # -----------------------------------------------------------------------------
+            # ## Concepts
+            #
+            # Project, namespace, kind, and entity as defined in the Google Cloud Datastore
+            # API.
+            #
+            # Operation: An Operation represents work being performed in the background.
+            #
+            # EntityFilter: Allows specifying a subset of entities in a project. This is
+            # specified as a combination of kinds and namespaces (either or both of which
+            # may be all).
+            #
+            # -----------------------------------------------------------------------------
+            # ## Services
+            #
+            # # Export/Import
+            #
+            # The Export/Import service provides the ability to copy all or a subset of
+            # entities to/from Google Cloud Storage.
+            #
+            # Exported data may be imported into Cloud Datastore for any Google Cloud
+            # Platform project. It is not restricted to the export source project. It is
+            # possible to export from one project and then import into another.
+            #
+            # Exported data can also be loaded into Google BigQuery for analysis.
+            #
+            # Exports and imports are performed asynchronously. An Operation resource is
+            # created for each export/import. The state (including any errors encountered)
+            # of the export/import may be queried via the Operation resource.
+            #
+            # # Index
+            #
+            # The index service manages Cloud Datastore composite indexes.
+            #
+            # Index creation and deletion are performed asynchronously.
+            # An Operation resource is created for each such asynchronous operation.
+            # The state of the operation (including any errors encountered)
+            # may be queried via the Operation resource.
+            #
+            # # Operation
+            #
+            # The Operations collection provides a record of actions performed for the
+            # specified project (including any operations in progress). Operations are not
+            # created directly but through calls on other collections or resources.
+            #
+            # An operation that is not yet done may be cancelled. The request to cancel is
+            # asynchronous and the operation may continue to run for some time after the
+            # request to cancel is made.
+            #
+            # An operation that is done may be deleted so that it is no longer listed as
+            # part of the Operation collection.
+            #
+            # ListOperations returns all pending operations, but not completed operations.
+            #
+            # Operations are created by service DatastoreAdmin,
+            # but are accessed via service google.longrunning.Operations.
+            #
+            class Client
+              # @private
+              attr_reader :datastore_admin_stub
+
+              ##
+              # Configure the DatastoreAdmin Client class.
+              #
+              # See {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # ## Example
+              #
+              # To modify the configuration for all DatastoreAdmin clients:
+              #
+              #     ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client.configure do |config|
+              #       config.timeout = 10.0
+              #     end
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def self.configure
+                @configure ||= begin
+                  namespace = ["Google", "Cloud", "Datastore", "Admin", "V1"]
+                  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
+                                    namespace.pop
+                                  end
+                  default_config = Client::Configuration.new parent_config
+
+                  default_config.rpcs.export_entities.timeout = 60.0
+
+                  default_config.rpcs.import_entities.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]
+                  }
+
+                  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]
+                  }
+
+                  default_config
+                end
+                yield @configure if block_given?
+                @configure
+              end
+
+              ##
+              # Configure the DatastoreAdmin Client instance.
+              #
+              # The configuration is set to the derived mode, meaning that values can be changed,
+              # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+              # should be made on {Client.configure}.
+              #
+              # See {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def configure
+                yield @config if block_given?
+                @config
+              end
+
+              ##
+              # Create a new DatastoreAdmin client object.
+              #
+              # ## Examples
+              #
+              # To create a new DatastoreAdmin client with the default
+              # configuration:
+              #
+              #     client = ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client.new
+              #
+              # To create a new DatastoreAdmin client with a custom
+              # configuration:
+              #
+              #     client = ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client.new do |config|
+              #       config.timeout = 10.0
+              #     end
+              #
+              # @yield [config] Configure the DatastoreAdmin client.
+              # @yieldparam config [Client::Configuration]
+              #
+              def initialize
+                # These require statements are intentionally placed here to initialize
+                # the gRPC module only when it's required.
+                # See https://github.com/googleapis/toolkit/issues/446
+                require "gapic/grpc"
+                require "google/datastore/admin/v1/datastore_admin_services_pb"
+
+                # Create the configuration object
+                @config = Configuration.new Client.configure
+
+                # Yield the configuration if needed
+                yield @config if block_given?
+
+                # Create credentials
+                credentials = @config.credentials
+                credentials ||= Credentials.default scope: @config.scope
+                if credentials.is_a?(String) || credentials.is_a?(Hash)
+                  credentials = Credentials.new credentials, scope: @config.scope
+                end
+                @quota_project_id = @config.quota_project
+                @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+                @operations_client = Operations.new do |config|
+                  config.credentials = credentials
+                  config.endpoint = @config.endpoint
+                end
+
+                @datastore_admin_stub = ::Gapic::ServiceStub.new(
+                  ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Stub,
+                  credentials:  credentials,
+                  endpoint:     @config.endpoint,
+                  channel_args: @config.channel_args,
+                  interceptors: @config.interceptors
+                )
+              end
+
+              ##
+              # Get the associated client for long-running operations.
+              #
+              # @return [::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Operations]
+              #
+              attr_reader :operations_client
+
+              # Service calls
+
+              ##
+              # Exports a copy of all or a subset of entities from Google Cloud Datastore
+              # to another storage system, such as Google Cloud Storage. Recent updates to
+              # entities may not be reflected in the export. The export occurs in the
+              # background and its progress can be monitored and managed via the
+              # Operation resource that is created. The output of an export may only be
+              # used once the associated operation is done. If an export operation is
+              # cancelled before completion it may leave partial data behind in Google
+              # Cloud Storage.
+              #
+              # @overload export_entities(request, options = nil)
+              #   Pass arguments to `export_entities` via a request object, either of type
+              #   {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest, ::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 export_entities(project_id: nil, labels: nil, entity_filter: nil, output_url_prefix: nil)
+              #   Pass arguments to `export_entities` 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]
+              #     Required. Project ID against which to make the request.
+              #   @param labels [::Hash{::String => ::String}]
+              #     Client-assigned labels.
+              #   @param entity_filter [::Google::Cloud::Datastore::Admin::V1::EntityFilter, ::Hash]
+              #     Description of what data from the project is included in the export.
+              #   @param output_url_prefix [::String]
+              #     Required. Location for the export metadata and data files.
+              #
+              #     The full resource URL of the external storage location. Currently, only
+              #     Google Cloud Storage is supported. So output_url_prefix should be of the
+              #     form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the
+              #     name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud
+              #     Storage namespace path (this is not a Cloud Datastore namespace). For more
+              #     information about Cloud Storage namespace paths, see
+              #     [Object name
+              #     considerations](https://cloud.google.com/storage/docs/naming#object-considerations).
+              #
+              #     The resulting files will be nested deeper than the specified URL prefix.
+              #     The final output URL will be provided in the
+              #     {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url} field. That
+              #     value should be used for subsequent ImportEntities operations.
+              #
+              #     By nesting the data files deeper, the same Cloud Storage bucket can be used
+              #     in multiple ExportEntities operations without conflict.
+              #
+              # @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 export_entities request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest
+
+                # 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.export_entities.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.export_entities.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.export_entities.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @datastore_admin_stub.call_rpc :export_entities, 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
+
+              ##
+              # Imports entities into Google Cloud Datastore. Existing entities with the
+              # same key are overwritten. The import occurs in the background and its
+              # progress can be monitored and managed via the Operation resource that is
+              # created. If an ImportEntities operation is cancelled, it is possible
+              # that a subset of the data has already been imported to Cloud Datastore.
+              #
+              # @overload import_entities(request, options = nil)
+              #   Pass arguments to `import_entities` via a request object, either of type
+              #   {::Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest, ::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 import_entities(project_id: nil, labels: nil, input_url: nil, entity_filter: nil)
+              #   Pass arguments to `import_entities` 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]
+              #     Required. Project ID against which to make the request.
+              #   @param labels [::Hash{::String => ::String}]
+              #     Client-assigned labels.
+              #   @param input_url [::String]
+              #     Required. The full resource URL of the external storage location. Currently, only
+              #     Google Cloud Storage is supported. So input_url should be of the form:
+              #     `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where
+              #     `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is
+              #     an optional Cloud Storage namespace path (this is not a Cloud Datastore
+              #     namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written
+              #     by the ExportEntities operation. For more information about Cloud Storage
+              #     namespace paths, see
+              #     [Object name
+              #     considerations](https://cloud.google.com/storage/docs/naming#object-considerations).
+              #
+              #     For more information, see
+              #     {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url}.
+              #   @param entity_filter [::Google::Cloud::Datastore::Admin::V1::EntityFilter, ::Hash]
+              #     Optionally specify which kinds/namespaces are to be imported. If provided,
+              #     the list must be a subset of the EntityFilter used in creating the export,
+              #     otherwise a FAILED_PRECONDITION error will be returned. If no filter is
+              #     specified then all entities from the export are imported.
+              #
+              # @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 import_entities request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest
+
+                # 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.import_entities.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.import_entities.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.import_entities.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @datastore_admin_stub.call_rpc :import_entities, 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.
+              #
+              # @overload get_index(request, options = nil)
+              #   Pass arguments to `get_index` via a request object, either of type
+              #   {::Google::Cloud::Datastore::Admin::V1::GetIndexRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Datastore::Admin::V1::GetIndexRequest, ::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 get_index(project_id: nil, index_id: nil)
+              #   Pass arguments to `get_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 get.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Cloud::Datastore::Admin::V1::Index]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Cloud::Datastore::Admin::V1::Index]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              def get_index request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastore::Admin::V1::GetIndexRequest
+
+                # 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.get_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.get_index.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.get_index.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @datastore_admin_stub.call_rpc :get_index, request, options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Lists the indexes that match the specified filters.  Datastore uses an
+              # eventually consistent query to fetch the list of indexes and may
+              # occasionally return stale results.
+              #
+              # @overload list_indexes(request, options = nil)
+              #   Pass arguments to `list_indexes` via a request object, either of type
+              #   {::Google::Cloud::Datastore::Admin::V1::ListIndexesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Datastore::Admin::V1::ListIndexesRequest, ::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 list_indexes(project_id: nil, filter: nil, page_size: nil, page_token: nil)
+              #   Pass arguments to `list_indexes` 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 filter [::String]
+              #   @param page_size [::Integer]
+              #     The maximum number of items to return.  If zero, then all results will be
+              #     returned.
+              #   @param page_token [::String]
+              #     The next_page_token value returned from a previous List request, if any.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastore::Admin::V1::Index>]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Gapic::PagedEnumerable<::Google::Cloud::Datastore::Admin::V1::Index>]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              def list_indexes request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastore::Admin::V1::ListIndexesRequest
+
+                # 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.list_indexes.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.list_indexes.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.list_indexes.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @datastore_admin_stub.call_rpc :list_indexes, request, options: options do |response, operation|
+                  response = ::Gapic::PagedEnumerable.new @datastore_admin_stub, :list_indexes, request, response, operation, 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 DatastoreAdmin API.
+              #
+              # This class represents the configuration for DatastoreAdmin,
+              # providing control over timeouts, retry behavior, logging, transport
+              # parameters, and other low-level controls. Certain parameters can also be
+              # applied individually to specific RPCs. See
+              # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client::Configuration::Rpcs}
+              # for a list of RPCs that can be configured independently.
+              #
+              # Configuration can be applied globally to all clients, or to a single client
+              # on construction.
+              #
+              # # Examples
+              #
+              # To modify the global config, setting the timeout for export_entities
+              # to 20 seconds, and all remaining timeouts to 10 seconds:
+              #
+              #     ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client.configure do |config|
+              #       config.timeout = 10.0
+              #       config.rpcs.export_entities.timeout = 20.0
+              #     end
+              #
+              # To apply the above configuration only to a new client:
+              #
+              #     client = ::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client.new do |config|
+              #       config.timeout = 10.0
+              #       config.rpcs.export_entities.timeout = 20.0
+              #     end
+              #
+              # @!attribute [rw] endpoint
+              #   The hostname or hostname:port of the service endpoint.
+              #   Defaults to `"datastore.googleapis.com"`.
+              #   @return [::String]
+              # @!attribute [rw] credentials
+              #   Credentials to send with calls. You may provide any of the following types:
+              #    *  (`String`) The path to a service account key file in JSON format
+              #    *  (`Hash`) A service account key as a Hash
+              #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+              #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+              #    *  (`nil`) indicating no credentials
+              #   @return [::Object]
+              # @!attribute [rw] scope
+              #   The OAuth scopes
+              #   @return [::Array<::String>]
+              # @!attribute [rw] lib_name
+              #   The library name as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] lib_version
+              #   The library version as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] channel_args
+              #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+              #   `GRPC::Core::Channel` object is provided as the credential.
+              #   @return [::Hash]
+              # @!attribute [rw] interceptors
+              #   An array of interceptors that are run before calls are executed.
+              #   @return [::Array<::GRPC::ClientInterceptor>]
+              # @!attribute [rw] timeout
+              #   The call timeout in seconds.
+              #   @return [::Numeric]
+              # @!attribute [rw] metadata
+              #   Additional gRPC headers to be sent with the call.
+              #   @return [::Hash{::Symbol=>::String}]
+              # @!attribute [rw] retry_policy
+              #   The retry policy. The value is a hash with the following keys:
+              #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #       trigger a retry.
+              #   @return [::Hash]
+              # @!attribute [rw] quota_project
+              #   A separate project against which to charge quota.
+              #   @return [::String]
+              #
+              class Configuration
+                extend ::Gapic::Config
+
+                config_attr :endpoint,      "datastore.googleapis.com", ::String
+                config_attr :credentials,   nil do |value|
+                  allowed = [::String, ::Hash, ::Proc, ::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 :interceptors,  nil, ::Array, nil
+                config_attr :timeout,       nil, ::Numeric, nil
+                config_attr :metadata,      nil, ::Hash, nil
+                config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+                config_attr :quota_project, nil, ::String, nil
+
+                # @private
+                def initialize parent_config = nil
+                  @parent_config = parent_config unless parent_config.nil?
+
+                  yield self if block_given?
+                end
+
+                ##
+                # Configurations for individual RPCs
+                # @return [Rpcs]
+                #
+                def rpcs
+                  @rpcs ||= begin
+                    parent_rpcs = nil
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                    Rpcs.new parent_rpcs
+                  end
+                end
+
+                ##
+                # Configuration RPC class for the DatastoreAdmin API.
+                #
+                # Includes fields providing the configuration for each RPC in this service.
+                # Each configuration object is of type `Gapic::Config::Method` and includes
+                # the following configuration fields:
+                #
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+                #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
+                #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+                #     include the following keys:
+                #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                #         trigger a retry.
+                #
+                class Rpcs
+                  ##
+                  # RPC-specific configuration for `export_entities`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :export_entities
+                  ##
+                  # RPC-specific configuration for `import_entities`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :import_entities
+                  ##
+                  # RPC-specific configuration for `get_index`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :get_index
+                  ##
+                  # RPC-specific configuration for `list_indexes`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_indexes
+
+                  # @private
+                  def initialize parent_rpcs = nil
+                    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 = ::Gapic::Config::Method.new import_entities_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 = ::Gapic::Config::Method.new list_indexes_config
+
+                    yield self if block_given?
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end