Package com.google.cloud.retail.v2alpha

Interface ExportUserEventsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExportUserEventsRequest, ExportUserEventsRequest.Builder
@Generated public interface ExportUserEventsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    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.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getParent

      String getParent()
       Required. Resource name of a
 [Catalog][google.cloud.retail.v2alpha.Catalog]. For example
 `projects/1234/locations/global/catalogs/default_catalog`
      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
 [Catalog][google.cloud.retail.v2alpha.Catalog]. For example
 `projects/1234/locations/global/catalogs/default_catalog`
      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 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:

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

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

 * `eventsMissingCatalogItems`: 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:
      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 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:

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

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

 * `eventsMissingCatalogItems`: 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:
      The bytes for filter.