google-cloud-datastore-admin-v1 0.1.0 → 0.4.0

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

@@ -22,7 +22,7 @@ module Google
     module Datastore
       module Admin
         module V1
-          VERSION = "0.1.0"
+          VERSION = "0.4.0"
         end
       end
     end

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

@@ -65,6 +65,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :kinds, :string, 1
       repeated :namespace_ids, :string, 2
     end
+    add_message "google.datastore.admin.v1.CreateIndexRequest" do
+      optional :project_id, :string, 1
+      optional :index, :message, 3, "google.datastore.admin.v1.Index"
+    end
+    add_message "google.datastore.admin.v1.DeleteIndexRequest" do
+      optional :project_id, :string, 1
+      optional :index_id, :string, 3
+    end
     add_message "google.datastore.admin.v1.GetIndexRequest" do
       optional :project_id, :string, 1
       optional :index_id, :string, 3
@@ -108,6 +116,8 @@ module Google
           ExportEntitiesMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ExportEntitiesMetadata").msgclass
           ImportEntitiesMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ImportEntitiesMetadata").msgclass
           EntityFilter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.EntityFilter").msgclass
+          CreateIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.CreateIndexRequest").msgclass
+          DeleteIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.DeleteIndexRequest").msgclass
           GetIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.GetIndexRequest").msgclass
           ListIndexesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ListIndexesRequest").msgclass
           ListIndexesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ListIndexesResponse").msgclass

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

@@ -102,19 +102,45 @@ module Google
               # 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.
-              rpc :ExportEntities, Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest, Google::Longrunning::Operation
+              rpc :ExportEntities, ::Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest, ::Google::Longrunning::Operation
               # 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.
-              rpc :ImportEntities, Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest, Google::Longrunning::Operation
+              rpc :ImportEntities, ::Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest, ::Google::Longrunning::Operation
+              # 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
+              # [delete][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex], then
+              # re-creating the index with [create]
+              # [google.datastore.admin.v1.DatastoreAdmin.CreateIndex].
+              #
+              # Indexes with a single property cannot be created.
+              rpc :CreateIndex, ::Google::Cloud::Datastore::Admin::V1::CreateIndexRequest, ::Google::Longrunning::Operation
+              # 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`
+              # [state][google.datastore.admin.v1.Index.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
+              # [delete][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex] again.
+              rpc :DeleteIndex, ::Google::Cloud::Datastore::Admin::V1::DeleteIndexRequest, ::Google::Longrunning::Operation
               # Gets an index.
-              rpc :GetIndex, Google::Cloud::Datastore::Admin::V1::GetIndexRequest, Google::Cloud::Datastore::Admin::V1::Index
+              rpc :GetIndex, ::Google::Cloud::Datastore::Admin::V1::GetIndexRequest, ::Google::Cloud::Datastore::Admin::V1::Index
               # 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.
-              rpc :ListIndexes, Google::Cloud::Datastore::Admin::V1::ListIndexesRequest, Google::Cloud::Datastore::Admin::V1::ListIndexesResponse
+              rpc :ListIndexes, ::Google::Cloud::Datastore::Admin::V1::ListIndexesRequest, ::Google::Cloud::Datastore::Admin::V1::ListIndexesResponse
             end
 
             Stub = Service.rpc_stub_class

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

@@ -0,0 +1,44 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/datastore/admin/v1/migration.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/datastore/admin/v1/migration.proto", :syntax => :proto3) do
+    add_message "google.datastore.admin.v1.MigrationStateEvent" do
+      optional :state, :enum, 1, "google.datastore.admin.v1.MigrationState"
+    end
+    add_message "google.datastore.admin.v1.MigrationProgressEvent" do
+      optional :step, :enum, 1, "google.datastore.admin.v1.MigrationStep"
+    end
+    add_enum "google.datastore.admin.v1.MigrationState" do
+      value :MIGRATION_STATE_UNSPECIFIED, 0
+      value :RUNNING, 1
+      value :PAUSED, 2
+      value :COMPLETE, 3
+    end
+    add_enum "google.datastore.admin.v1.MigrationStep" do
+      value :MIGRATION_STEP_UNSPECIFIED, 0
+      value :START, 1
+      value :COPY_AND_VERIFY, 2
+      value :REDIRECT_EVENTUALLY_CONSISTENT_READS, 3
+      value :REDIRECT_STRONGLY_CONSISTENT_READS, 4
+      value :REDIRECT_WRITES, 5
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        module V1
+          MigrationStateEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.MigrationStateEvent").msgclass
+          MigrationProgressEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.MigrationProgressEvent").msgclass
+          MigrationState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.MigrationState").enummodule
+          MigrationStep = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.MigrationStep").enummodule
+        end
+      end
+    end
+  end
+end

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

data/proto_docs/google/datastore/admin/v1/datastore_admin.rb

@@ -281,6 +281,33 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # The request for
+          # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#create_index google.datastore.admin.v1.DatastoreAdmin.CreateIndex}.
+          # @!attribute [rw] project_id
+          #   @return [::String]
+          #     Project ID against which to make the request.
+          # @!attribute [rw] index
+          #   @return [::Google::Cloud::Datastore::Admin::V1::Index]
+          #     The index to create. The name and state fields are output only and will be
+          #     ignored. Single property indexes cannot be created or deleted.
+          class CreateIndexRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for
+          # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#delete_index google.datastore.admin.v1.DatastoreAdmin.DeleteIndex}.
+          # @!attribute [rw] project_id
+          #   @return [::String]
+          #     Project ID against which to make the request.
+          # @!attribute [rw] index_id
+          #   @return [::String]
+          #     The resource ID of the index to delete.
+          class DeleteIndexRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The request for {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#get_index google.datastore.admin.v1.DatastoreAdmin.GetIndex}.
           # @!attribute [rw] project_id
           #   @return [::String]

data/proto_docs/google/datastore/admin/v1/index.rb

@@ -22,7 +22,7 @@ module Google
     module Datastore
       module Admin
         module V1
-          # A minimal index definition.
+          # Datastore composite index definition.
           # @!attribute [r] project_id
           #   @return [::String]
           #     Output only. Project ID.

data/proto_docs/google/datastore/admin/v1/migration.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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!
+
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        module V1
+          # An event signifying a change in state of a [migration from Cloud Datastore to
+          # Cloud Firestore in Datastore
+          # mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::Datastore::Admin::V1::MigrationState]
+          #     The new state of the migration.
+          class MigrationStateEvent
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # An event signifying the start of a new step in a [migration from Cloud
+          # Datastore to Cloud Firestore in Datastore
+          # mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).
+          # @!attribute [rw] step
+          #   @return [::Google::Cloud::Datastore::Admin::V1::MigrationStep]
+          #     The step that is starting.
+          #
+          #     An event with step set to `START` indicates that the migration
+          #     has been reverted back to the initial pre-migration state.
+          class MigrationProgressEvent
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # States for a migration.
+          module MigrationState
+            # Unspecified.
+            MIGRATION_STATE_UNSPECIFIED = 0
+
+            # The migration is running.
+            RUNNING = 1
+
+            # The migration is paused.
+            PAUSED = 2
+
+            # The migration is complete.
+            COMPLETE = 3
+          end
+
+          # Steps in a migration.
+          module MigrationStep
+            # Unspecified.
+            MIGRATION_STEP_UNSPECIFIED = 0
+
+            # Start of migration.
+            START = 1
+
+            # Data is copied to Cloud Firestore and then verified to match the data in
+            # Cloud Datastore.
+            COPY_AND_VERIFY = 2
+
+            # Eventually-consistent reads are redirected to Cloud Firestore.
+            REDIRECT_EVENTUALLY_CONSISTENT_READS = 3
+
+            # Strongly-consistent reads are redirected to Cloud Firestore.
+            REDIRECT_STRONGLY_CONSISTENT_READS = 4
+
+            # Writes are redirected to Cloud Firestore.
+            REDIRECT_WRITES = 5
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -25,7 +25,7 @@ module Google
     #   @return [::String]
     #     The server-assigned name, which is only unique within the same service that
     #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should have the format of `operations/some/unique/name`.
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
     # @!attribute [rw] metadata
     #   @return [::Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically
@@ -35,7 +35,7 @@ module Google
     # @!attribute [rw] done
     #   @return [::Boolean]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
     # The request message for Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
-    #     The name of the operation collection.
+    #     The name of the operation's parent resource.
     # @!attribute [rw] filter
     #   @return [::String]
     #     The standard list filter.
@@ -112,6 +112,20 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     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.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # A message representing the message types used by a long-running operation.
     #
     # Example:

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #