Package com.google.cloud.retail.v2alpha

Class ExportUserEventsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ExportUserEventsRequest.Builder>
com.google.cloud.retail.v2alpha.ExportUserEventsRequest.Builder
All Implemented Interfaces:
ExportUserEventsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ExportUserEventsRequest
public static final class ExportUserEventsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ExportUserEventsRequest.Builder> implements ExportUserEventsRequestOrBuilder
 Request message for the `ExportUserEvents` method.
Protobuf type google.cloud.retail.v2alpha.ExportUserEventsRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ExportUserEventsRequest.Builder>

    • clear

      public ExportUserEventsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ExportUserEventsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ExportUserEventsRequest.Builder>

    • getDefaultInstanceForType

      public ExportUserEventsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ExportUserEventsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ExportUserEventsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ExportUserEventsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportUserEventsRequest.Builder>

    • mergeFrom

      public ExportUserEventsRequest.Builder mergeFrom(ExportUserEventsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ExportUserEventsRequest.Builder>

    • mergeFrom

      public ExportUserEventsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportUserEventsRequest.Builder>
      Throws:
      IOException

    • getParent

      public 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) = { ... }
      Specified by:
      getParent in interface ExportUserEventsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ExportUserEventsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public ExportUserEventsRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ExportUserEventsRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public ExportUserEventsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • hasOutputConfig

      public boolean hasOutputConfig()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasOutputConfig in interface ExportUserEventsRequestOrBuilder
      Returns:
      Whether the outputConfig field is set.

    • getOutputConfig

      public OutputConfig getOutputConfig()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputConfig in interface ExportUserEventsRequestOrBuilder
      Returns:
      The outputConfig.

    • setOutputConfig

      public ExportUserEventsRequest.Builder setOutputConfig(OutputConfig value)
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

    • setOutputConfig

      public ExportUserEventsRequest.Builder setOutputConfig(OutputConfig.Builder builderForValue)
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

    • mergeOutputConfig

      public ExportUserEventsRequest.Builder mergeOutputConfig(OutputConfig value)
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

    • clearOutputConfig

      public ExportUserEventsRequest.Builder clearOutputConfig()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

    • getOutputConfigBuilder

      public OutputConfig.Builder getOutputConfigBuilder()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

    • getOutputConfigOrBuilder

      public OutputConfigOrBuilder getOutputConfigOrBuilder()
       Required. The output location of the data.
      .google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOutputConfigOrBuilder in interface ExportUserEventsRequestOrBuilder

    • getFilter

      public 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;
      Specified by:
      getFilter in interface ExportUserEventsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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;
      Specified by:
      getFilterBytes in interface ExportUserEventsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public ExportUserEventsRequest.Builder setFilter(String value)
       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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ExportUserEventsRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public ExportUserEventsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.