google-cloud-recommendation_engine-v1beta1 0.1.0

data/proto_docs/google/cloud/recommendationengine/v1beta1/catalog_service.rb

@@ -0,0 +1,110 @@
+# 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 RecommendationEngine
+      module V1beta1
+        # Request message for CreateCatalogItem method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent catalog resource name, such as
+        #     "projects/*/locations/global/catalogs/default_catalog".
+        # @!attribute [rw] catalog_item
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem]
+        #     Required. The catalog item to create.
+        class CreateCatalogItemRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for GetCatalogItem method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of catalog item, such as
+        #     "projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id".
+        class GetCatalogItemRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for ListCatalogItems method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent catalog resource name, such as
+        #     "projects/*/locations/global/catalogs/default_catalog".
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of results to return per page. If zero, the
+        #     service will choose a reasonable default.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The previous ListCatalogItemsResponse.next_page_token.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A filter to apply on the list results.
+        class ListCatalogItemsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ListCatalogItems method.
+        # @!attribute [rw] catalog_items
+        #   @return [::Array<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem>]
+        #     The catalog items.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If empty, the list is complete. If nonempty, the token to pass to the next
+        #     request's ListCatalogItemRequest.page_token.
+        class ListCatalogItemsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for UpdateCatalogItem method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of catalog item, such as
+        #     "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
+        # @!attribute [rw] catalog_item
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem]
+        #     Required. The catalog item to update/create. The 'catalog_item_id' field
+        #     has to match that in the 'name'.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Indicates which fields in the provided 'item' to update. If not
+        #     set, will by default update all fields.
+        class UpdateCatalogItemRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for DeleteCatalogItem method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of catalog item, such as
+        #     "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
+        class DeleteCatalogItemRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/recommendationengine/v1beta1/common.rb

@@ -0,0 +1,89 @@
+# 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 RecommendationEngine
+      module V1beta1
+        # FeatureMap represents extra features that customers want to include in the
+        # recommendation model for catalogs/user events as categorical/numerical
+        # features.
+        # @!attribute [rw] categorical_features
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap::StringList}]
+        #     Categorical features that can take on one of a limited number of possible
+        #     values. Some examples would be the brand/maker of a product, or country of
+        #     a customer.
+        #
+        #     Feature names and values must be UTF-8 encoded strings.
+        #
+        #     For example: `{ "colors": {"value": ["yellow", "green"]},
+        #                     "sizes": \\{"value":["S", "M"]}`
+        # @!attribute [rw] numerical_features
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap::FloatList}]
+        #     Numerical features. Some examples would be the height/weight of a product,
+        #     or age of a customer.
+        #
+        #     Feature names must be UTF-8 encoded strings.
+        #
+        #     For example: `{ "lengths_cm": {"value":[2.3, 15.4]},
+        #                     "heights_cm": \\{"value":[8.1, 6.4]} }`
+        class FeatureMap
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A list of string features.
+          # @!attribute [rw] value
+          #   @return [::Array<::String>]
+          #     String feature value with a length limit of 128 bytes.
+          class StringList
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A list of float features.
+          # @!attribute [rw] value
+          #   @return [::Array<::Float>]
+          #     Float feature value.
+          class FloatList
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap::StringList]
+          class CategoricalFeaturesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap::FloatList]
+          class NumericalFeaturesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/recommendationengine/v1beta1/import.rb

@@ -0,0 +1,206 @@
+# 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 RecommendationEngine
+      module V1beta1
+        # Google Cloud Storage location for input content.
+        # format.
+        # @!attribute [rw] input_uris
+        #   @return [::Array<::String>]
+        #     Required. Google Cloud Storage URIs to input files. URI can be up to
+        #     2000 characters long. URIs can match the full object path (for example,
+        #     gs://bucket/directory/object.json) or a pattern matching one or more
+        #     files, such as gs://bucket/directory/*.json. A request can
+        #     contain at most 100 files, and each file can be up to 2 GB. See
+        #     [Importing catalog information](/recommendations-ai/docs/upload-catalog)
+        #     for the expected file format and setup instructions.
+        class GcsSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The inline source for the input config for ImportCatalogItems method.
+        # @!attribute [rw] catalog_items
+        #   @return [::Array<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem>]
+        #     Optional. A list of catalog items to update/create. Recommended max of 10k
+        #     items.
+        class CatalogInlineSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The inline source for the input config for ImportUserEvents method.
+        # @!attribute [rw] user_events
+        #   @return [::Array<::Google::Cloud::RecommendationEngine::V1beta1::UserEvent>]
+        #     Optional. A list of user events to import. Recommended max of 10k items.
+        class UserEventInlineSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration of destination for Import related errors.
+        # @!attribute [rw] gcs_prefix
+        #   @return [::String]
+        #     Google Cloud Storage path for import errors. This must be an empty,
+        #     existing Cloud Storage bucket. Import errors will be written to a file in
+        #     this bucket, one per line, as a JSON-encoded
+        #     `google.rpc.Status` message.
+        class ImportErrorsConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for Import methods.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. "projects/1234/locations/global/catalogs/default_catalog"
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. Unique identifier provided by client, within the ancestor
+        #     dataset scope. Ensures idempotency and used for request deduplication.
+        #     Server-generated if unspecified. Up to 128 characters long. This is
+        #     returned as google.longrunning.Operation.name in the response.
+        # @!attribute [rw] input_config
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::InputConfig]
+        #     Required. The desired input location of the data.
+        # @!attribute [rw] errors_config
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::ImportErrorsConfig]
+        #     Optional. The desired location of errors incurred during the Import.
+        class ImportCatalogItemsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the ImportUserEvents request.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required.
+        #     "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. Unique identifier provided by client, within the ancestor
+        #     dataset scope. Ensures idempotency for expensive long running operations.
+        #     Server-generated if unspecified. Up to 128 characters long. This is
+        #     returned as google.longrunning.Operation.name in the response. Note that
+        #     this field must not be set if the desired input config is
+        #     catalog_inline_source.
+        # @!attribute [rw] input_config
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::InputConfig]
+        #     Required. The desired input location of the data.
+        # @!attribute [rw] errors_config
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::ImportErrorsConfig]
+        #     Optional. The desired location of errors incurred during the Import.
+        class ImportUserEventsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The input config source.
+        # @!attribute [rw] catalog_inline_source
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::CatalogInlineSource]
+        #     The Inline source for the input content for Catalog items.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::GcsSource]
+        #     Google Cloud Storage location for the input content.
+        # @!attribute [rw] user_event_inline_source
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::UserEventInlineSource]
+        #     The Inline source for the input content for UserEvents.
+        class InputConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the Import operation. This will be
+        # returned by the google.longrunning.Operation.metadata field.
+        # @!attribute [rw] operation_name
+        #   @return [::String]
+        #     Name of the operation.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Id of the request / operation. This is parroting back the requestId that
+        #     was passed in the request.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] success_count
+        #   @return [::Integer]
+        #     Count of entries that were processed successfully.
+        # @!attribute [rw] failure_count
+        #   @return [::Integer]
+        #     Count of entries that encountered errors while processing.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class ImportMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the ImportCatalogItemsRequest. If the long running
+        # operation is done, then this message is returned by the
+        # google.longrunning.Operations.response field if the operation was successful.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] errors_config
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::ImportErrorsConfig]
+        #     Echoes the destination for the complete errors in the request if set.
+        class ImportCatalogItemsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the ImportUserEventsRequest. If the long running
+        # operation was successful, then this message is returned by the
+        # google.longrunning.Operations.response field if the operation was successful.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] errors_config
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::ImportErrorsConfig]
+        #     Echoes the destination for the complete errors if this field was set in
+        #     the request.
+        # @!attribute [rw] import_summary
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::UserEventImportSummary]
+        #     Aggregated statistics of user event import status.
+        class ImportUserEventsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A summary of import result. The UserEventImportSummary summarizes
+        # the import status for user events.
+        # @!attribute [rw] joined_events_count
+        #   @return [::Integer]
+        #     Count of user events imported with complete existing catalog information.
+        # @!attribute [rw] unjoined_events_count
+        #   @return [::Integer]
+        #     Count of user events imported, but with catalog information not found
+        #     in the imported catalog.
+        class UserEventImportSummary
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/recommendationengine/v1beta1/prediction_apikey_registry_service.rb

@@ -0,0 +1,88 @@
+# 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 RecommendationEngine
+      module V1beta1
+        # Registered Api Key.
+        # @!attribute [rw] api_key
+        #   @return [::String]
+        #     The API key.
+        class PredictionApiKeyRegistration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the `CreatePredictionApiKeyRegistration` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource path.
+        #     "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store".
+        # @!attribute [rw] prediction_api_key_registration
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration]
+        #     Required. The prediction API key registration.
+        class CreatePredictionApiKeyRegistrationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the `ListPredictionApiKeyRegistrations`.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent placement resource name such as
+        #     "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of results to return per page. If unset, the
+        #     service will choose a reasonable default.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.
+        class ListPredictionApiKeyRegistrationsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the `ListPredictionApiKeyRegistrations`.
+        # @!attribute [rw] prediction_api_key_registrations
+        #   @return [::Array<::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration>]
+        #     The list of registered API keys.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If empty, the list is complete. If nonempty, pass the token to the next
+        #     request's `ListPredictionApiKeysRegistrationsRequest.pageToken`.
+        class ListPredictionApiKeyRegistrationsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for `DeletePredictionApiKeyRegistration` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The API key to unregister including full resource path.
+        #     "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>"
+        class DeletePredictionApiKeyRegistrationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end