Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportProductsRequest

Inherits:

Object

• Object
• Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportProductsRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/representations.rb

Overview

Request message for ExportProducts method.

Instance Attribute Summary

• #filter ⇒ String

  A filtering expression to specify restrictions on returned events.

• #output_config ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfig

  The output configuration setting.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudRetailV2alphaExportProductsRequest constructor

  A new instance of GoogleCloudRetailV2alphaExportProductsRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaExportProductsRequest

Returns a new instance of GoogleCloudRetailV2alphaExportProductsRequest.

# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3146

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#filter ⇒ String

A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime<"2012-04-23T18: 25:43.511Z" productType=primary We expect only four types of fields: * lastModifiedTime: This can be specified twice, once with a less than operator and once with a greater than operator. The lastModifiedTime restriction should result in one, contiguous, valid, last-modified, time range. * productType: Supported values are primary and variant. The Boolean operators OR and NOT are supported if the expression is enclosed in parentheses and must be separated from the productType values by a space. * availability: Supported values are IN_STOCK, OUT_OF_STOCK, PREORDER, and BACKORDER. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses and must be separated from the availability values by a space. * Tag expressions: Restricts output to products that match all of the specified tags. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '-"tagA"', which is equivalent to 'NOT "tagA"'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: lastModifiedTime > "2012-04-23T18:25: 43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z" * Example 2: lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant" * Example 3: tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z" * Example 4: lastModifiedTime > "2012-04-23T18:25:43.511Z" * Example 5: availability = (IN_STOCK OR BACKORDER) Corresponds to the JSON property filter

Returns:

• (String)

# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3139

def filter
  @filter
end

#output_config ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfig

The output configuration setting. Corresponds to the JSON property outputConfig

Returns:

• (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfig)

# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3144

def output_config
  @output_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3151

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @output_config = args[:output_config] if args.key?(:output_config)
end