google-apis-retail_v2 0.88.0 → 0.89.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54582d1dd8e8e04af512667e123c5a7df6631974c494529d5542f36cfab3045d
-  data.tar.gz: be0c929e09d1ea3dfd09e732325b0425944fe263fff97833e9a24071c39663bc
+  metadata.gz: b5afe8ba40c38222eed4bca1d27f3ee9c9db1ef56c9c566eabd84b2f6fbe4c77
+  data.tar.gz: d2c5fb5c82b21f617f30afe3b118db31ad4d44c6cb5f919d19c137c6f04d850b
 SHA512:
-  metadata.gz: a6f128948a79c7b84aaa1c4bd46c23e7da46a53c2873aedbb47ecf3de12d1760a42349b6eea77a979f9e23ec5942428067a66a0d711406ab63626a401c1514f8
-  data.tar.gz: df5a674f409a6708444a8f2a01dc5c274545c7d7110a39f3ec2ef84cd6612968d463d4fdca76646941db32a2e7756ba1a264c3608c4365ad1f9b7ce2f2db2163
+  metadata.gz: f3dfa09013c2e0b02b8971a2851a88880bd8f982b4e7547250115f523dd6bb36b3a1aae7b9b01d4ba8bd562a77186f4a3fce994886d3ce70c2eb18d9e0266d62
+  data.tar.gz: 359736fc92f917bc890b36da4cb8958b38dbe1eabc68f2165899724cd2f432c311b9d3e644d5c22265d2c8c9a1e295c498ef81e90d219fea5d9d2a88aca21d58

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2
 
+### v0.89.0 (2024-02-11)
+
+* Regenerated from discovery document revision 20240205
+
 ### v0.88.0 (2024-02-04)
 
 * Regenerated from discovery document revision 20240129

data/lib/google/apis/retail_v2/classes.rb

@@ -560,6 +560,31 @@ module Google
         end
       end
       
+      # A BigQuery output result.
+      class GoogleCloudRetailV2BigQueryOutputResult
+        include Google::Apis::Core::Hashable
+      
+        # The ID of a BigQuery Dataset.
+        # Corresponds to the JSON property `datasetId`
+        # @return [String]
+        attr_accessor :dataset_id
+      
+        # The ID of a BigQuery Table.
+        # Corresponds to the JSON property `tableId`
+        # @return [String]
+        attr_accessor :table_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
+          @table_id = args[:table_id] if args.key?(:table_id)
+        end
+      end
+      
       # BigQuery source import data from.
       class GoogleCloudRetailV2BigQuerySource
         include Google::Apis::Core::Hashable
@@ -1551,6 +1576,94 @@ module Google
         end
       end
       
+      # Request message for the `ExportAnalyticsMetrics` method.
+      class GoogleCloudRetailV2ExportAnalyticsMetricsRequest
+        include Google::Apis::Core::Hashable
+      
+        # A filtering expression to specify restrictions on returned metrics. The
+        # expression is a sequence of terms. Each term applies a restriction to the
+        # returned metrics. Use this expression to restrict results to a specific time
+        # range. Currently we expect only one types of fields: * `timestamp`: This can
+        # be specified twice, once with a less than operator and once with a greater
+        # than operator. The `timestamp` restriction should result in one, contiguous,
+        # valid, `timestamp` range. Some examples of valid filters expressions: *
+        # Example 1: `timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:
+        # 30:43.511Z"` * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # The output configuration setting.
+        # Corresponds to the JSON property `outputConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfig]
+        attr_accessor :output_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @filter = args[:filter] if args.key?(:filter)
+          @output_config = args[:output_config] if args.key?(:output_config)
+        end
+      end
+      
+      # Response of the ExportAnalyticsMetricsRequest. If the long running operation
+      # was successful, then this message is returned by the google.longrunning.
+      # Operations.response field if the operation was successful.
+      class GoogleCloudRetailV2ExportAnalyticsMetricsResponse
+        include Google::Apis::Core::Hashable
+      
+        # A sample of errors encountered while processing the request.
+        # Corresponds to the JSON property `errorSamples`
+        # @return [Array<Google::Apis::RetailV2::GoogleRpcStatus>]
+        attr_accessor :error_samples
+      
+        # Configuration of destination for Export related errors.
+        # Corresponds to the JSON property `errorsConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ExportErrorsConfig]
+        attr_accessor :errors_config
+      
+        # Output result that stores the information about where the exported data is
+        # stored.
+        # Corresponds to the JSON property `outputResult`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2OutputResult]
+        attr_accessor :output_result
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @error_samples = args[:error_samples] if args.key?(:error_samples)
+          @errors_config = args[:errors_config] if args.key?(:errors_config)
+          @output_result = args[:output_result] if args.key?(:output_result)
+        end
+      end
+      
+      # Configuration of destination for Export related errors.
+      class GoogleCloudRetailV2ExportErrorsConfig
+        include Google::Apis::Core::Hashable
+      
+        # Google Cloud Storage path for import errors. This must be an empty, existing
+        # Cloud Storage bucket. Export errors will be written to a file in this bucket,
+        # one per line, as a JSON-encoded `google.rpc.Status` message.
+        # Corresponds to the JSON property `gcsPrefix`
+        # @return [String]
+        attr_accessor :gcs_prefix
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
+        end
+      end
+      
       # Fulfillment information, such as the store IDs for in-store pickup or region
       # IDs for different shipping methods.
       class GoogleCloudRetailV2FulfillmentInfo
@@ -1587,6 +1700,25 @@ module Google
         end
       end
       
+      # A Gcs output result.
+      class GoogleCloudRetailV2GcsOutputResult
+        include Google::Apis::Core::Hashable
+      
+        # The uri of Gcs output
+        # Corresponds to the JSON property `outputUri`
+        # @return [String]
+        attr_accessor :output_uri
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @output_uri = args[:output_uri] if args.key?(:output_uri)
+        end
+      end
+      
       # Google Cloud Storage location for input content.
       class GoogleCloudRetailV2GcsSource
         include Google::Apis::Core::Hashable
@@ -2392,6 +2524,113 @@ module Google
         end
       end
       
+      # The output configuration setting.
+      class GoogleCloudRetailV2OutputConfig
+        include Google::Apis::Core::Hashable
+      
+        # The BigQuery output destination configuration.
+        # Corresponds to the JSON property `bigqueryDestination`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigBigQueryDestination]
+        attr_accessor :bigquery_destination
+      
+        # The Google Cloud Storage output destination configuration.
+        # Corresponds to the JSON property `gcsDestination`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigGcsDestination]
+        attr_accessor :gcs_destination
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination)
+          @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
+        end
+      end
+      
+      # The BigQuery output destination configuration.
+      class GoogleCloudRetailV2OutputConfigBigQueryDestination
+        include Google::Apis::Core::Hashable
+      
+        # Required. The ID of a BigQuery Dataset.
+        # Corresponds to the JSON property `datasetId`
+        # @return [String]
+        attr_accessor :dataset_id
+      
+        # Required. The prefix of exported BigQuery tables.
+        # Corresponds to the JSON property `tableIdPrefix`
+        # @return [String]
+        attr_accessor :table_id_prefix
+      
+        # Required. Describes the table type. The following values are supported: * `
+        # table`: A BigQuery native table. * `view`: A virtual table defined by a SQL
+        # query.
+        # Corresponds to the JSON property `tableType`
+        # @return [String]
+        attr_accessor :table_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
+          @table_id_prefix = args[:table_id_prefix] if args.key?(:table_id_prefix)
+          @table_type = args[:table_type] if args.key?(:table_type)
+        end
+      end
+      
+      # The Google Cloud Storage output destination configuration.
+      class GoogleCloudRetailV2OutputConfigGcsDestination
+        include Google::Apis::Core::Hashable
+      
+        # Required. The output uri prefix for saving output data to json files. Some
+        # mapping examples are as follows: output_uri_prefix sample output(assuming the
+        # object is foo.json) ======================== ==================================
+        # =========== gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/
+        # folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
+        # Corresponds to the JSON property `outputUriPrefix`
+        # @return [String]
+        attr_accessor :output_uri_prefix
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix)
+        end
+      end
+      
+      # Output result that stores the information about where the exported data is
+      # stored.
+      class GoogleCloudRetailV2OutputResult
+        include Google::Apis::Core::Hashable
+      
+        # The BigQuery location where the result is stored.
+        # Corresponds to the JSON property `bigqueryResult`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2BigQueryOutputResult>]
+        attr_accessor :bigquery_result
+      
+        # The Google Cloud Storage location where the result is stored.
+        # Corresponds to the JSON property `gcsResult`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2GcsOutputResult>]
+        attr_accessor :gcs_result
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
+          @gcs_result = args[:gcs_result] if args.key?(:gcs_result)
+        end
+      end
+      
       # Request for pausing training of a model.
       class GoogleCloudRetailV2PauseModelRequest
         include Google::Apis::Core::Hashable

data/lib/google/apis/retail_v2/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.88.0"
+      GEM_VERSION = "0.89.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.13.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240129"
+      REVISION = "20240205"
     end
   end
 end

data/lib/google/apis/retail_v2/representations.rb

@@ -124,6 +124,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2BigQueryOutputResult
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2BigQuerySource
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -262,12 +268,36 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2ExportAnalyticsMetricsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2ExportAnalyticsMetricsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2ExportErrorsConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2FulfillmentInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2GcsOutputResult
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2GcsSource
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -400,6 +430,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2OutputConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2OutputConfigBigQueryDestination
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2OutputConfigGcsDestination
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2OutputResult
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2PauseModelRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1525,6 +1579,14 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2BigQueryOutputResult
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :dataset_id, as: 'datasetId'
+          property :table_id, as: 'tableId'
+        end
+      end
+      
       class GoogleCloudRetailV2BigQuerySource
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1760,6 +1822,34 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2ExportAnalyticsMetricsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :filter, as: 'filter'
+          property :output_config, as: 'outputConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfig::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2ExportAnalyticsMetricsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :error_samples, as: 'errorSamples', class: Google::Apis::RetailV2::GoogleRpcStatus, decorator: Google::Apis::RetailV2::GoogleRpcStatus::Representation
+      
+          property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2ExportErrorsConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ExportErrorsConfig::Representation
+      
+          property :output_result, as: 'outputResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2OutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2OutputResult::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2ExportErrorsConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :gcs_prefix, as: 'gcsPrefix'
+        end
+      end
+      
       class GoogleCloudRetailV2FulfillmentInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1768,6 +1858,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2GcsOutputResult
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :output_uri, as: 'outputUri'
+        end
+      end
+      
       class GoogleCloudRetailV2GcsSource
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1988,6 +2085,42 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2OutputConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigBigQueryDestination, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigBigQueryDestination::Representation
+      
+          property :gcs_destination, as: 'gcsDestination', class: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigGcsDestination, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigGcsDestination::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2OutputConfigBigQueryDestination
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :dataset_id, as: 'datasetId'
+          property :table_id_prefix, as: 'tableIdPrefix'
+          property :table_type, as: 'tableType'
+        end
+      end
+      
+      class GoogleCloudRetailV2OutputConfigGcsDestination
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :output_uri_prefix, as: 'outputUriPrefix'
+        end
+      end
+      
+      class GoogleCloudRetailV2OutputResult
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :bigquery_result, as: 'bigqueryResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2BigQueryOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2BigQueryOutputResult::Representation
+      
+          collection :gcs_result, as: 'gcsResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2GcsOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2GcsOutputResult::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2PauseModelRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/retail_v2/service.rb

@@ -134,6 +134,42 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Exports analytics metrics. `Operation.response` is of type `
+        # ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `
+        # ExportMetadata`.
+        # @param [String] catalog
+        #   Required. Full resource name of the parent catalog. Expected format: `projects/
+        #   */locations/*/catalogs/*`
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2ExportAnalyticsMetricsRequest] google_cloud_retail_v2_export_analytics_metrics_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+catalog}:exportAnalyticsMetrics', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ExportAnalyticsMetricsRequest::Representation
+          command.request_object = google_cloud_retail_v2_export_analytics_metrics_request_object
+          command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation
+          command.params['catalog'] = catalog unless catalog.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets an AttributesConfig.
         # @param [String] name
         #   Required. Full AttributesConfig resource name. Format: `projects/`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.88.0
+  version: 0.89.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-04 00:00:00.000000000 Z
+date: 2024-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.88.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.89.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []