- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public interface ExportProductsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
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.v2alpha.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.v2alpha.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.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the outputConfig field is set. |