com.google.cloud.retail.v2alpha

Interface ExportProductsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ExportProductsRequest, ExportProductsRequest.Builder

public interface ExportProductsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() A filtering expression to specify restrictions on returned events.
com.google.protobuf.ByteString	getFilterBytes() A filtering expression to specify restrictions on returned events.
OutputConfig	getOutputConfig() Required.
OutputConfigOrBuilder	getOutputConfigOrBuilder() Required.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
boolean	hasOutputConfig() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. Resource name of a [Branch][google.cloud.retail.v2alpha.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:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. Resource name of a [Branch][google.cloud.retail.v2alpha.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:

The bytes for parent.

hasOutputConfig

boolean hasOutputConfig()

 Required. The output location of the data.
 

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

Returns:

Whether the outputConfig field is set.

getOutputConfig

OutputConfig getOutputConfig()

 Required. The output location of the data.
 

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

Returns:

The outputConfig.

getOutputConfigOrBuilder

OutputConfigOrBuilder getOutputConfigOrBuilder()

 Required. The output location of the data.
 

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

getFilter

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:

    * `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)`
 

string filter = 3;

Returns:

The filter.

getFilterBytes

com.google.protobuf.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:

    * `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)`
 

string filter = 3;

Returns:

The bytes for filter.