google-cloud-datastore-admin-v1 0.1.0

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

@@ -0,0 +1,364 @@
+# 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!
+
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        module V1
+          # Metadata common to all Datastore Admin operations.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time that work began on the operation.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time the operation ended, either successfully or otherwise.
+          # @!attribute [rw] operation_type
+          #   @return [::Google::Cloud::Datastore::Admin::V1::OperationType]
+          #     The type of the operation. Can be used as a filter in
+          #     ListOperationsRequest.
+          # @!attribute [rw] labels
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     The client-assigned labels which were provided when the operation was
+          #     created. May also include additional labels.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::Datastore::Admin::V1::CommonMetadata::State]
+          #     The current state of the Operation.
+          class CommonMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class LabelsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The various possible states for an ongoing Operation.
+            module State
+              # Unspecified.
+              STATE_UNSPECIFIED = 0
+
+              # Request is being prepared for processing.
+              INITIALIZING = 1
+
+              # Request is actively being processed.
+              PROCESSING = 2
+
+              # Request is in the process of being cancelled after user called
+              # google.longrunning.Operations.CancelOperation on the operation.
+              CANCELLING = 3
+
+              # Request has been processed and is in its finalization stage.
+              FINALIZING = 4
+
+              # Request has completed successfully.
+              SUCCESSFUL = 5
+
+              # Request has finished being processed, but encountered an error.
+              FAILED = 6
+
+              # Request has finished being cancelled after user called
+              # google.longrunning.Operations.CancelOperation.
+              CANCELLED = 7
+            end
+          end
+
+          # Measures the progress of a particular metric.
+          # @!attribute [rw] work_completed
+          #   @return [::Integer]
+          #     The amount of work that has been completed. Note that this may be greater
+          #     than work_estimated.
+          # @!attribute [rw] work_estimated
+          #   @return [::Integer]
+          #     An estimate of how much work needs to be performed. May be zero if the
+          #     work estimate is unavailable.
+          class Progress
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for
+          # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#export_entities google.datastore.admin.v1.DatastoreAdmin.ExportEntities}.
+          # @!attribute [rw] project_id
+          #   @return [::String]
+          #     Required. Project ID against which to make the request.
+          # @!attribute [rw] labels
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Client-assigned labels.
+          # @!attribute [rw] entity_filter
+          #   @return [::Google::Cloud::Datastore::Admin::V1::EntityFilter]
+          #     Description of what data from the project is included in the export.
+          # @!attribute [rw] output_url_prefix
+          #   @return [::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.
+          class ExportEntitiesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class LabelsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The request for
+          # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#import_entities google.datastore.admin.v1.DatastoreAdmin.ImportEntities}.
+          # @!attribute [rw] project_id
+          #   @return [::String]
+          #     Required. Project ID against which to make the request.
+          # @!attribute [rw] labels
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Client-assigned labels.
+          # @!attribute [rw] input_url
+          #   @return [::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}.
+          # @!attribute [rw] entity_filter
+          #   @return [::Google::Cloud::Datastore::Admin::V1::EntityFilter]
+          #     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.
+          class ImportEntitiesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class LabelsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The response for
+          # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#export_entities google.datastore.admin.v1.DatastoreAdmin.ExportEntities}.
+          # @!attribute [rw] output_url
+          #   @return [::String]
+          #     Location of the output metadata file. This can be used to begin an import
+          #     into Cloud Datastore (this project or another project). See
+          #     {::Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest#input_url google.datastore.admin.v1.ImportEntitiesRequest.input_url}.
+          #     Only present if the operation completed successfully.
+          class ExportEntitiesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for ExportEntities operations.
+          # @!attribute [rw] common
+          #   @return [::Google::Cloud::Datastore::Admin::V1::CommonMetadata]
+          #     Metadata common to all Datastore Admin operations.
+          # @!attribute [rw] progress_entities
+          #   @return [::Google::Cloud::Datastore::Admin::V1::Progress]
+          #     An estimate of the number of entities processed.
+          # @!attribute [rw] progress_bytes
+          #   @return [::Google::Cloud::Datastore::Admin::V1::Progress]
+          #     An estimate of the number of bytes processed.
+          # @!attribute [rw] entity_filter
+          #   @return [::Google::Cloud::Datastore::Admin::V1::EntityFilter]
+          #     Description of which entities are being exported.
+          # @!attribute [rw] output_url_prefix
+          #   @return [::String]
+          #     Location for the export metadata and data files. This will be the same
+          #     value as the
+          #     {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest#output_url_prefix google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix}
+          #     field. The final output location is provided in
+          #     {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url}.
+          class ExportEntitiesMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for ImportEntities operations.
+          # @!attribute [rw] common
+          #   @return [::Google::Cloud::Datastore::Admin::V1::CommonMetadata]
+          #     Metadata common to all Datastore Admin operations.
+          # @!attribute [rw] progress_entities
+          #   @return [::Google::Cloud::Datastore::Admin::V1::Progress]
+          #     An estimate of the number of entities processed.
+          # @!attribute [rw] progress_bytes
+          #   @return [::Google::Cloud::Datastore::Admin::V1::Progress]
+          #     An estimate of the number of bytes processed.
+          # @!attribute [rw] entity_filter
+          #   @return [::Google::Cloud::Datastore::Admin::V1::EntityFilter]
+          #     Description of which entities are being imported.
+          # @!attribute [rw] input_url
+          #   @return [::String]
+          #     The location of the import metadata file. This will be the same value as
+          #     the {::Google::Cloud::Datastore::Admin::V1::ExportEntitiesResponse#output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url} field.
+          class ImportEntitiesMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Identifies a subset of entities in a project. This is specified as
+          # combinations of kinds and namespaces (either or both of which may be all, as
+          # described in the following examples).
+          # Example usage:
+          #
+          # Entire project:
+          #   kinds=[], namespace_ids=[]
+          #
+          # Kinds Foo and Bar in all namespaces:
+          #   kinds=['Foo', 'Bar'], namespace_ids=[]
+          #
+          # Kinds Foo and Bar only in the default namespace:
+          #   kinds=['Foo', 'Bar'], namespace_ids=['']
+          #
+          # Kinds Foo and Bar in both the default and Baz namespaces:
+          #   kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']
+          #
+          # The entire Baz namespace:
+          #   kinds=[], namespace_ids=['Baz']
+          # @!attribute [rw] kinds
+          #   @return [::Array<::String>]
+          #     If empty, then this represents all kinds.
+          # @!attribute [rw] namespace_ids
+          #   @return [::Array<::String>]
+          #     An empty list represents all namespaces. This is the preferred
+          #     usage for projects that don't use namespaces.
+          #
+          #     An empty string element represents the default namespace. This should be
+          #     used if the project has data in non-default namespaces, but doesn't want to
+          #     include them.
+          #     Each namespace in this list must be unique.
+          class EntityFilter
+            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]
+          #     Project ID against which to make the request.
+          # @!attribute [rw] index_id
+          #   @return [::String]
+          #     The resource ID of the index to get.
+          class GetIndexRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for
+          # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#list_indexes google.datastore.admin.v1.DatastoreAdmin.ListIndexes}.
+          # @!attribute [rw] project_id
+          #   @return [::String]
+          #     Project ID against which to make the request.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return.  If zero, then all results will be
+          #     returned.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous List request, if any.
+          class ListIndexesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response for
+          # {::Google::Cloud::Datastore::Admin::V1::DatastoreAdmin::Client#list_indexes google.datastore.admin.v1.DatastoreAdmin.ListIndexes}.
+          # @!attribute [rw] indexes
+          #   @return [::Array<::Google::Cloud::Datastore::Admin::V1::Index>]
+          #     The indexes.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     The standard List next-page token.
+          class ListIndexesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for Index operations.
+          # @!attribute [rw] common
+          #   @return [::Google::Cloud::Datastore::Admin::V1::CommonMetadata]
+          #     Metadata common to all Datastore Admin operations.
+          # @!attribute [rw] progress_entities
+          #   @return [::Google::Cloud::Datastore::Admin::V1::Progress]
+          #     An estimate of the number of entities processed.
+          # @!attribute [rw] index_id
+          #   @return [::String]
+          #     The index resource ID that this operation is acting on.
+          class IndexOperationMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Operation types.
+          module OperationType
+            # Unspecified.
+            OPERATION_TYPE_UNSPECIFIED = 0
+
+            # ExportEntities.
+            EXPORT_ENTITIES = 1
+
+            # ImportEntities.
+            IMPORT_ENTITIES = 2
+
+            # CreateIndex.
+            CREATE_INDEX = 3
+
+            # DeleteIndex.
+            DELETE_INDEX = 4
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+# 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!
+
+
+module Google
+  module Cloud
+    module Datastore
+      module Admin
+        module V1
+          # A minimal index definition.
+          # @!attribute [r] project_id
+          #   @return [::String]
+          #     Output only. Project ID.
+          # @!attribute [r] index_id
+          #   @return [::String]
+          #     Output only. The resource ID of the index.
+          # @!attribute [rw] kind
+          #   @return [::String]
+          #     Required. The entity kind to which this index applies.
+          # @!attribute [rw] ancestor
+          #   @return [::Google::Cloud::Datastore::Admin::V1::Index::AncestorMode]
+          #     Required. The index's ancestor mode.  Must not be ANCESTOR_MODE_UNSPECIFIED.
+          # @!attribute [rw] properties
+          #   @return [::Array<::Google::Cloud::Datastore::Admin::V1::Index::IndexedProperty>]
+          #     Required. An ordered sequence of property names and their index attributes.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::Datastore::Admin::V1::Index::State]
+          #     Output only. The state of the index.
+          class Index
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A property of an index.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     Required. The property name to index.
+            # @!attribute [rw] direction
+            #   @return [::Google::Cloud::Datastore::Admin::V1::Index::Direction]
+            #     Required. The indexed property's direction.  Must not be DIRECTION_UNSPECIFIED.
+            class IndexedProperty
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # For an ordered index, specifies whether each of the entity's ancestors
+            # will be included.
+            module AncestorMode
+              # The ancestor mode is unspecified.
+              ANCESTOR_MODE_UNSPECIFIED = 0
+
+              # Do not include the entity's ancestors in the index.
+              NONE = 1
+
+              # Include all the entity's ancestors in the index.
+              ALL_ANCESTORS = 2
+            end
+
+            # The direction determines how a property is indexed.
+            module Direction
+              # The direction is unspecified.
+              DIRECTION_UNSPECIFIED = 0
+
+              # The property's values are indexed so as to support sequencing in
+              # ascending order and also query by <, >, <=, >=, and =.
+              ASCENDING = 1
+
+              # The property's values are indexed so as to support sequencing in
+              # descending order and also query by <, >, <=, >=, and =.
+              DESCENDING = 2
+            end
+
+            # The possible set of states of an index.
+            module State
+              # The state is unspecified.
+              STATE_UNSPECIFIED = 0
+
+              # The index is being created, and cannot be used by queries.
+              # There is an active long-running operation for the index.
+              # The index is updated when writing an entity.
+              # Some index data may exist.
+              CREATING = 1
+
+              # The index is ready to be used.
+              # The index is updated when writing an entity.
+              # The index is fully populated from all stored entities it applies to.
+              READY = 2
+
+              # The index is being deleted, and cannot be used by queries.
+              # There is an active long-running operation for the index.
+              # The index is not updated when writing an entity.
+              # Some index data may exist.
+              DELETING = 3
+
+              # The index was being created or deleted, but something went wrong.
+              # The index cannot by used by queries.
+              # There is no active long-running operation for the index,
+              # and the most recently finished long-running operation failed.
+              # The index is not updated when writing an entity.
+              # Some index data may exist.
+              ERROR = 4
+            end
+          end
+        end
+      end
+    end
+  end
+end