google-cloud-recommendation_engine-v1beta1 0.1.0

data/proto_docs/google/api/httpbody.rb

@@ -0,0 +1,75 @@
+# 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 Api
+    # Message that represents an arbitrary HTTP body. It should only be used for
+    # payload formats that can't be represented as JSON, such as raw binary or
+    # an HTML page.
+    #
+    #
+    # This message can be used both in streaming and non-streaming API methods in
+    # the request as well as the response.
+    #
+    # It can be used as a top-level request field, which is convenient if one
+    # wants to extract parameters from either the URL or HTTP template into the
+    # request fields and also want access to the raw HTTP body.
+    #
+    # Example:
+    #
+    #     message GetResourceRequest {
+    #       // A unique request id.
+    #       string request_id = 1;
+    #
+    #       // The raw HTTP body is bound to this field.
+    #       google.api.HttpBody http_body = 2;
+    #     }
+    #
+    #     service ResourceService {
+    #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
+    #       rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);
+    #     }
+    #
+    # Example with streaming methods:
+    #
+    #     service CaldavService {
+    #       rpc GetCalendar(stream google.api.HttpBody)
+    #         returns (stream google.api.HttpBody);
+    #       rpc UpdateCalendar(stream google.api.HttpBody)
+    #         returns (stream google.api.HttpBody);
+    #     }
+    #
+    # Use of this type only changes how the request and response bodies are
+    # handled, all other features will continue to work unchanged.
+    # @!attribute [rw] content_type
+    #   @return [::String]
+    #     The HTTP Content-Type string representing the content type of the body.
+    # @!attribute [rw] data
+    #   @return [::String]
+    #     HTTP body binary data.
+    # @!attribute [rw] extensions
+    #   @return [::Array<::Google::Protobuf::Any>]
+    #     Application specific response metadata. Must be set in the first response
+    #     for streaming APIs.
+    class HttpBody
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,283 @@
+# 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 Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // 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}"
+    #         }
+    #       };
+    #     }
+    #
+    # 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}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     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}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     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"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     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
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # 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
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             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
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #         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
+    end
+  end
+end

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

@@ -0,0 +1,214 @@
+# 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
+        # CatalogItem captures all metadata information of items to be recommended.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     Required. Catalog item identifier. UTF-8 encoded string with a length limit
+        #     of 128 bytes.
+        #
+        #     This id must be unique among all catalog items within the same catalog. It
+        #     should also be used when logging user events in order for the user events
+        #     to be joined with the Catalog.
+        # @!attribute [rw] category_hierarchies
+        #   @return [::Array<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem::CategoryHierarchy>]
+        #     Required. Catalog item categories. This field is repeated for supporting
+        #     one catalog item belonging to several parallel category hierarchies.
+        #
+        #     For example, if a shoes product belongs to both
+        #     ["Shoes & Accessories" -> "Shoes"] and
+        #     ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
+        #     represented as:
+        #
+        #          "categoryHierarchies": [
+        #            { "categories": ["Shoes & Accessories", "Shoes"]},
+        #            { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
+        #          ]
+        # @!attribute [rw] title
+        #   @return [::String]
+        #     Required. Catalog item title. UTF-8 encoded string with a length limit of 1
+        #     KiB.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. Catalog item description. UTF-8 encoded string with a length
+        #     limit of 5 KiB.
+        # @!attribute [rw] item_attributes
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap]
+        #     Optional. Highly encouraged. Extra catalog item attributes to be
+        #     included in the recommendation model. For example, for retail products,
+        #     this could include the store name, vendor, style, color, etc. These are
+        #     very strong signals for recommendation model, thus we highly recommend
+        #     providing the item attributes here.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Optional. Language of the title/description/item_attributes. Use language
+        #     tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our
+        #     supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh',
+        #     'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact
+        #     your Google account manager.
+        # @!attribute [rw] tags
+        #   @return [::Array<::String>]
+        #     Optional. Filtering tags associated with the catalog item. Each tag should
+        #     be a UTF-8 encoded string with a length limit of 1 KiB.
+        #
+        #     This tag can be used for filtering recommendation results by passing the
+        #     tag as part of the predict request filter.
+        # @!attribute [rw] item_group_id
+        #   @return [::String]
+        #     Optional. Variant group identifier for prediction results. UTF-8 encoded
+        #     string with a length limit of 128 bytes.
+        #
+        #     This field must be enabled before it can be used. [Learn
+        #     more](/recommendations-ai/docs/catalog#item-group-id).
+        # @!attribute [rw] product_metadata
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::ProductCatalogItem]
+        #     Optional. Metadata specific to retail products.
+        class CatalogItem
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Category represents catalog item category hierarchy.
+          # @!attribute [rw] categories
+          #   @return [::Array<::String>]
+          #     Required. Catalog item categories. Each category should be a UTF-8
+          #     encoded string with a length limit of 2 KiB.
+          #
+          #     Note that the order in the list denotes the specificity (from least to
+          #     most specific).
+          class CategoryHierarchy
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # ProductCatalogItem captures item metadata specific to retail products.
+        # @!attribute [rw] exact_price
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::ProductCatalogItem::ExactPrice]
+        #     Optional. The exact product price.
+        # @!attribute [rw] price_range
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::ProductCatalogItem::PriceRange]
+        #     Optional. The product price range.
+        # @!attribute [rw] costs
+        #   @return [::Google::Protobuf::Map{::String => ::Float}]
+        #     Optional. A map to pass the costs associated with the product.
+        #
+        #     For example:
+        #     \\{"manufacturing": 45.5} The profit of selling this item is computed like
+        #     so:
+        #
+        #     * If 'exactPrice' is provided, profit = displayPrice - sum(costs)
+        #     * If 'priceRange' is provided, profit = minPrice - sum(costs)
+        # @!attribute [rw] currency_code
+        #   @return [::String]
+        #     Optional. Only required if the price is set. Currency code for price/costs. Use
+        #     three-character ISO-4217 code.
+        # @!attribute [rw] stock_state
+        #   @return [::Google::Cloud::RecommendationEngine::V1beta1::ProductCatalogItem::StockState]
+        #     Optional. Online stock state of the catalog item. Default is `IN_STOCK`.
+        # @!attribute [rw] available_quantity
+        #   @return [::Integer]
+        #     Optional. The available quantity of the item.
+        # @!attribute [rw] canonical_product_uri
+        #   @return [::String]
+        #     Optional. Canonical URL directly linking to the item detail page with a
+        #     length limit of 5 KiB..
+        # @!attribute [rw] images
+        #   @return [::Array<::Google::Cloud::RecommendationEngine::V1beta1::Image>]
+        #     Optional. Product images for the catalog item.
+        class ProductCatalogItem
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Exact product price.
+          # @!attribute [rw] display_price
+          #   @return [::Float]
+          #     Optional. Display price of the product.
+          # @!attribute [rw] original_price
+          #   @return [::Float]
+          #     Optional. Price of the product without any discount. If zero, by default
+          #     set to be the 'displayPrice'.
+          class ExactPrice
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Product price range when there are a range of prices for different
+          # variations of the same product.
+          # @!attribute [rw] min
+          #   @return [::Float]
+          #     Required. The minimum product price.
+          # @!attribute [rw] max
+          #   @return [::Float]
+          #     Required. The maximum product price.
+          class PriceRange
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Float]
+          class CostsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Item stock state. If this field is unspecified, the item is
+          # assumed to be in stock.
+          module StockState
+            # Default item stock status. Should never be used.
+            STOCK_STATE_UNSPECIFIED = 0
+
+            # Item in stock.
+            IN_STOCK = 0
+
+            # Item out of stock.
+            OUT_OF_STOCK = 1
+
+            # Item that is in pre-order state.
+            PREORDER = 2
+
+            # Item that is back-ordered (i.e. temporarily out of stock).
+            BACKORDER = 3
+          end
+        end
+
+        # Catalog item thumbnail/detail image.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     Required. URL of the image with a length limit of 5 KiB.
+        # @!attribute [rw] height
+        #   @return [::Integer]
+        #     Optional. Height of the image in number of pixels.
+        # @!attribute [rw] width
+        #   @return [::Integer]
+        #     Optional. Width of the image in number of pixels.
+        class Image
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end