Class ExportUserEventsRequest.Builder (2.85.0) 

public static final class ExportUserEventsRequest.Builder extends GeneratedMessage.Builder<ExportUserEventsRequest.Builder> implements ExportUserEventsRequestOrBuilder

Request message for the ExportUserEvents method.

Protobuf type google.cloud.retail.v2alpha.ExportUserEventsRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ExportUserEventsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ExportUserEventsRequest build()
Returns
Type Description
ExportUserEventsRequest

buildPartial()

public ExportUserEventsRequest buildPartial()
Returns
Type Description
ExportUserEventsRequest

clear()

public ExportUserEventsRequest.Builder clear()
Returns
Type Description
ExportUserEventsRequest.Builder
Overrides

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
Type Description
ExportUserEventsRequest.Builder

This builder for chaining.

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];

Returns
Type Description
ExportUserEventsRequest.Builder

clearParent()

public ExportUserEventsRequest.Builder clearParent()

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
ExportUserEventsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ExportUserEventsRequest getDefaultInstanceForType()
Returns
Type Description
ExportUserEventsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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;

Returns
Type Description
String

The filter.

getFilterBytes()

public 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
Type Description
ByteString

The bytes for filter.

getOutputConfig()

public 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.

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];

Returns
Type Description
OutputConfig.Builder

getOutputConfigOrBuilder()

public 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ExportUserEventsRequest other)

public ExportUserEventsRequest.Builder mergeFrom(ExportUserEventsRequest other)
Parameter
Name Description
other ExportUserEventsRequest
Returns
Type Description
ExportUserEventsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportUserEventsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportUserEventsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExportUserEventsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExportUserEventsRequest.Builder
Overrides

mergeOutputConfig(OutputConfig value)

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];

Parameter
Name Description
value OutputConfig
Returns
Type Description
ExportUserEventsRequest.Builder

setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ExportUserEventsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ExportUserEventsRequest.Builder setFilterBytes(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;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ExportUserEventsRequest.Builder

This builder for chaining.

setOutputConfig(OutputConfig value)

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];

Parameter
Name Description
value OutputConfig
Returns
Type Description
ExportUserEventsRequest.Builder

setOutputConfig(OutputConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue OutputConfig.Builder
Returns
Type Description
ExportUserEventsRequest.Builder

setParent(String value)

public ExportUserEventsRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ExportUserEventsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ExportUserEventsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ExportUserEventsRequest.Builder

This builder for chaining.