Interface ExportUserEventsRequestOrBuilder (2.54.0)

public interface ExportUserEventsRequestOrBuilder 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 user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search

We expect only three types of fields:

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

* <code>eventType</code>: 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.

* <code>eventsMissingCatalogItems</code>: This restricts results
  to events for which catalog items were not found in the catalog. The
  default behavior is to return only those events for which catalog
  items were found.

Some examples of valid filters expressions:

Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view
Example 3: eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"
Example 4: eventTime > "2012-04-23T18:25:43.511Z"
Example 5: eventType = (detail-page-view OR search)
Example 6: eventsMissingCatalogItems

string filter = 3;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

We expect only three types of fields:

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

* <code>eventType</code>: 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.

* <code>eventsMissingCatalogItems</code>: This restricts results
  to events for which catalog items were not found in the catalog. The
  default behavior is to return only those events for which catalog
  items were found.

Some examples of valid filters expressions:

Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view
Example 3: eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"
Example 4: eventTime > "2012-04-23T18:25:43.511Z"
Example 5: eventType = (detail-page-view OR search)
Example 6: eventsMissingCatalogItems

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 Catalog. For example projects/1234/locations/global/catalogs/default_catalog

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 Catalog. For example projects/1234/locations/global/catalogs/default_catalog

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.