Interface ExportProductsRequestOrBuilder (2.54.0) 

public interface ExportProductsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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:

* <code>lastModifiedTime</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>lastModifiedTime</code> restriction should result in one, contiguous,
  valid, last-modified, time range.

* <code>productType</code>: Supported values are <code>primary</code> and <code>variant</code>. The
Boolean operators <code>OR</code> and <code>NOT</code> are supported if the expression is
enclosed in parentheses and must be separated from the
  <code>productType</code> values by a space.

* <code>availability</code>: Supported values are <code>IN_STOCK</code>, <code>OUT_OF_STOCK</code>,
<code>PREORDER</code>, and <code>BACKORDER</code>. Boolean operators <code>OR</code> and <code>NOT</code> are
supported if the expression is enclosed in parentheses and must be
separated from the <code>availability</code> values by a space.

* <code>Tag expressions</code>: Restricts output to products that match all of the
  specified tags. Boolean operators <code>OR</code> and <code>NOT</code> are supported if the
  expression is enclosed in parentheses and the operators are separated
  from the tag values by a space. Also supported is '<code>-"tagA"</code>', which
  is equivalent to '<code>NOT "tagA"</code>'. 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)

string filter = 3;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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:

* <code>lastModifiedTime</code>: This can be specified twice, once with a
  less than operator and once with a greater than operator. The
  <code>lastModifiedTime</code> restriction should result in one, contiguous,
  valid, last-modified, time range.

* <code>productType</code>: Supported values are <code>primary</code> and <code>variant</code>. The
Boolean operators <code>OR</code> and <code>NOT</code> are supported if the expression is
enclosed in parentheses and must be separated from the
  <code>productType</code> values by a space.

* <code>availability</code>: Supported values are <code>IN_STOCK</code>, <code>OUT_OF_STOCK</code>,
<code>PREORDER</code>, and <code>BACKORDER</code>. Boolean operators <code>OR</code> and <code>NOT</code> are
supported if the expression is enclosed in parentheses and must be
separated from the <code>availability</code> values by a space.

* <code>Tag expressions</code>: Restricts output to products that match all of the
  specified tags. Boolean operators <code>OR</code> and <code>NOT</code> are supported if the
  expression is enclosed in parentheses and the operators are separated
  from the tag values by a space. Also supported is '<code>-"tagA"</code>', which
  is equivalent to '<code>NOT "tagA"</code>'. 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)

string filter = 3;

Returns
Type Description
ByteString

The bytes for filter.

getOutputConfig()

public abstract OutputConfig getOutputConfig()

Required. The output location of the data.

.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfig

The outputConfig.

getOutputConfigOrBuilder()

public abstract OutputConfigOrBuilder getOutputConfigOrBuilder()

Required. The output location of the data.

.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfigOrBuilder

getParent()

public abstract String getParent()

Required. Resource name of a Branch, and default_branch for branch_id component is supported. For example projects/1234/locations/global/catalogs/default_catalog/branches/default_branch

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. Resource name of a Branch, and default_branch for branch_id component is supported. For example projects/1234/locations/global/catalogs/default_catalog/branches/default_branch

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

hasOutputConfig()

public abstract boolean hasOutputConfig()

Required. The output location of the data.

.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the outputConfig field is set.