google-cloud-datastore-admin-v1 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49649dd73e8047afa2fdd6f4324843531b30001495a5918a28a540aa54806bf9
-  data.tar.gz: e5d2e462c04795ae11a6274f91efa852de564dafe4abe653bc96e2a20ebb751c
+  metadata.gz: 0ca6046c780883224fe1f4ed29bc1edfbf7182502322a7e708b0dcdecb752d87
+  data.tar.gz: 7c6d51c70eef7acdf489f206bca97213d6a8f003d4e9a12b39e0b8da45b223f9
 SHA512:
-  metadata.gz: 0edb37d1f476ee9107bfdb260f0860465fc28ace395057971e7a54ede247442b1fb28a75ebd8a307922fd141990031c05521ef8440ad1229082a819b37d727c5
-  data.tar.gz: a615a1d94825f154fa6505ae4fa083ed454ca60f6db9d7f2e988f27f1edda5288f5ecdf2edeefa7e7e18d00b114c4b30436548a7a8d650bf9a478f3e4f72634c
+  metadata.gz: 49db6a1584b623fb5baa755bec8abb6607bc884f061e08a1dab40d342a8d04df867114fea30814ad6ae6a3a86c11ca4a5388ba1a1bee719a2b64223772c0f4c4
+  data.tar.gz: 4bdefb78cf08b84c514d51c0afc239a40a94eee74555780451b3be1077e022ff3093c03466583fef72384e93163df5d3411bdf6d9976c14a08d7345b32938b6b

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Firestore in Datastore mode Admin V1 API
+--title="Firestore in Datastore mode Admin V1 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

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

@@ -212,6 +212,7 @@ module Google
 
                 @operations_client = Operations.new do |config|
                   config.credentials = credentials
+                  config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
                 end
 

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

@@ -22,7 +22,7 @@ module Google
     module Datastore
       module Admin
         module V1
-          VERSION = "0.4.5"
+          VERSION = "0.5.0"
         end
       end
     end

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

@@ -5,6 +5,7 @@ require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/datastore/admin/v1/index_pb'
+require 'google/datastore/admin/v1/migration_pb'
 require 'google/longrunning/operations_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf'
@@ -92,6 +93,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :progress_entities, :message, 2, "google.datastore.admin.v1.Progress"
       optional :index_id, :string, 3
     end
+    add_message "google.datastore.admin.v1.DatastoreFirestoreMigrationMetadata" do
+      optional :migration_state, :enum, 1, "google.datastore.admin.v1.MigrationState"
+      optional :migration_step, :enum, 2, "google.datastore.admin.v1.MigrationStep"
+    end
     add_enum "google.datastore.admin.v1.OperationType" do
       value :OPERATION_TYPE_UNSPECIFIED, 0
       value :EXPORT_ENTITIES, 1
@@ -122,6 +127,7 @@ module Google
           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
           IndexOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.IndexOperationMetadata").msgclass
+          DatastoreFirestoreMigrationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.DatastoreFirestoreMigrationMetadata").msgclass
           OperationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.OperationType").enummodule
         end
       end

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

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/datastore/admin/v1/datastore_admin.proto for package 'Google.Cloud.Datastore.Admin.V1'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# 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.

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

@@ -0,0 +1,65 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/datastore/admin/v1/migration.proto
+
+require 'google/api/annotations_pb'
+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"
+      oneof :step_details do
+        optional :prepare_step_details, :message, 2, "google.datastore.admin.v1.MigrationProgressEvent.PrepareStepDetails"
+        optional :redirect_writes_step_details, :message, 3, "google.datastore.admin.v1.MigrationProgressEvent.RedirectWritesStepDetails"
+      end
+    end
+    add_message "google.datastore.admin.v1.MigrationProgressEvent.PrepareStepDetails" do
+      optional :concurrency_mode, :enum, 1, "google.datastore.admin.v1.MigrationProgressEvent.ConcurrencyMode"
+    end
+    add_message "google.datastore.admin.v1.MigrationProgressEvent.RedirectWritesStepDetails" do
+      optional :concurrency_mode, :enum, 1, "google.datastore.admin.v1.MigrationProgressEvent.ConcurrencyMode"
+    end
+    add_enum "google.datastore.admin.v1.MigrationProgressEvent.ConcurrencyMode" do
+      value :CONCURRENCY_MODE_UNSPECIFIED, 0
+      value :PESSIMISTIC, 1
+      value :OPTIMISTIC, 2
+    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 :PREPARE, 6
+      value :START, 1
+      value :APPLY_WRITES_SYNCHRONOUSLY, 7
+      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
+          MigrationProgressEvent::PrepareStepDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.MigrationProgressEvent.PrepareStepDetails").msgclass
+          MigrationProgressEvent::RedirectWritesStepDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.MigrationProgressEvent.RedirectWritesStepDetails").msgclass
+          MigrationProgressEvent::ConcurrencyMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.MigrationProgressEvent.ConcurrencyMode").enummodule
+          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/resource.rb

@@ -33,11 +33,7 @@ module Google
     #       // For Kubernetes resources, the format is {api group}/{kind}.
     #       option (google.api.resource) = {
     #         type: "pubsub.googleapis.com/Topic"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
+    #         pattern: "projects/{project}/topics/{topic}"
     #       };
     #     }
     #
@@ -45,10 +41,7 @@ module Google
     #
     #     resources:
     #     - type: "pubsub.googleapis.com/Topic"
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
+    #       pattern: "projects/{project}/topics/{topic}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
     #     message LogEntry {
     #       option (google.api.resource) = {
     #         type: "logging.googleapis.com/LogEntry"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #         }
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
     #       };
     #     }
     #
@@ -85,48 +62,10 @@ module Google
     #
     #     resources:
     #     - type: 'logging.googleapis.com/LogEntry'
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         - pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         - pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #
-    # For flexible resources, the resource name doesn't contain parent names, but
-    # the resource itself has parents for policy evaluation.
-    #
-    # Example:
-    #
-    #     message Shelf {
-    #       option (google.api.resource) = {
-    #         type: "library.googleapis.com/Shelf"
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #         }
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: 'library.googleapis.com/Shelf'
-    #       name_descriptor:
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
     # @!attribute [rw] type
     #   @return [::String]
     #     The resource type. It must be in the format of

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

@@ -367,6 +367,27 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Metadata for Datastore to Firestore migration operations.
+          #
+          # The DatastoreFirestoreMigration operation is not started by the end-user via
+          # an explicit "creation" method. This is an intentional deviation from the LRO
+          # design pattern.
+          #
+          # This singleton resource can be accessed at:
+          # `projects/{project_id}/datastore-firestore-migration`
+          # @!attribute [rw] migration_state
+          #   @return [::Google::Cloud::Datastore::Admin::V1::MigrationState]
+          #     The current state of migration from Cloud Datastore to Cloud Firestore in
+          #     Datastore mode.
+          # @!attribute [rw] migration_step
+          #   @return [::Google::Cloud::Datastore::Admin::V1::MigrationStep]
+          #     The current step of migration from Cloud Datastore to Cloud Firestore in
+          #     Datastore mode.
+          class DatastoreFirestoreMigrationMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Operation types.
           module OperationType
             # Unspecified.

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

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+          # @!attribute [rw] prepare_step_details
+          #   @return [::Google::Cloud::Datastore::Admin::V1::MigrationProgressEvent::PrepareStepDetails]
+          #     Details for the `PREPARE` step.
+          # @!attribute [rw] redirect_writes_step_details
+          #   @return [::Google::Cloud::Datastore::Admin::V1::MigrationProgressEvent::RedirectWritesStepDetails]
+          #     Details for the `REDIRECT_WRITES` step.
+          class MigrationProgressEvent
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Details for the `PREPARE` step.
+            # @!attribute [rw] concurrency_mode
+            #   @return [::Google::Cloud::Datastore::Admin::V1::MigrationProgressEvent::ConcurrencyMode]
+            #     The concurrency mode this database will use when it reaches the
+            #     `REDIRECT_WRITES` step.
+            class PrepareStepDetails
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Details for the `REDIRECT_WRITES` step.
+            # @!attribute [rw] concurrency_mode
+            #   @return [::Google::Cloud::Datastore::Admin::V1::MigrationProgressEvent::ConcurrencyMode]
+            #     Ths concurrency mode for this database.
+            class RedirectWritesStepDetails
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Concurrency modes for transactions in Cloud Firestore.
+            module ConcurrencyMode
+              # Unspecified.
+              CONCURRENCY_MODE_UNSPECIFIED = 0
+
+              # Pessimistic concurrency.
+              PESSIMISTIC = 1
+
+              # Optimistic concurrency.
+              OPTIMISTIC = 2
+            end
+          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
+
+            # Pre-migration: the database is prepared for migration.
+            PREPARE = 6
+
+            # Start of migration.
+            START = 1
+
+            # Writes are applied synchronously to at least one replica.
+            APPLY_WRITES_SYNCHRONOUSLY = 7
+
+            # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore-admin-v1
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -179,11 +179,13 @@ files:
 - lib/google/datastore/admin/v1/datastore_admin_pb.rb
 - lib/google/datastore/admin/v1/datastore_admin_services_pb.rb
 - lib/google/datastore/admin/v1/index_pb.rb
+- lib/google/datastore/admin/v1/migration_pb.rb
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
 - proto_docs/google/datastore/admin/v1/datastore_admin.rb
 - proto_docs/google/datastore/admin/v1/index.rb
+- proto_docs/google/datastore/admin/v1/migration.rb
 - proto_docs/google/longrunning/operations.rb
 - proto_docs/google/protobuf/any.rb
 - proto_docs/google/protobuf/duration.rb
@@ -209,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: API Client library for the Firestore in Datastore mode Admin V1 API