public static final class ExportUserEventsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder> implements ExportUserEventsRequestOrBuilder
Request message for the `ExportUserEvents` method.Protobuf type
google.cloud.retail.v2alpha.ExportUserEventsRequest| Modifier and Type | Method and Description |
|---|---|
ExportUserEventsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ExportUserEventsRequest |
build() |
ExportUserEventsRequest |
buildPartial() |
ExportUserEventsRequest.Builder |
clear() |
ExportUserEventsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ExportUserEventsRequest.Builder |
clearFilter()
A filtering expression to specify restrictions on returned events.
|
ExportUserEventsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ExportUserEventsRequest.Builder |
clearOutputConfig()
Required.
|
ExportUserEventsRequest.Builder |
clearParent()
Required.
|
ExportUserEventsRequest.Builder |
clone() |
ExportUserEventsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
OutputConfig.Builder |
getOutputConfigBuilder()
Required.
|
OutputConfigOrBuilder |
getOutputConfigOrBuilder()
Required.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
boolean |
hasOutputConfig()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ExportUserEventsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ExportUserEventsRequest.Builder |
mergeFrom(ExportUserEventsRequest other) |
ExportUserEventsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ExportUserEventsRequest.Builder |
mergeOutputConfig(OutputConfig value)
Required.
|
ExportUserEventsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ExportUserEventsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ExportUserEventsRequest.Builder |
setFilter(String value)
A filtering expression to specify restrictions on returned events.
|
ExportUserEventsRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
A filtering expression to specify restrictions on returned events.
|
ExportUserEventsRequest.Builder |
setOutputConfig(OutputConfig.Builder builderForValue)
Required.
|
ExportUserEventsRequest.Builder |
setOutputConfig(OutputConfig value)
Required.
|
ExportUserEventsRequest.Builder |
setParent(String value)
Required.
|
ExportUserEventsRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
ExportUserEventsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ExportUserEventsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ExportUserEventsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ExportUserEventsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ExportUserEventsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest.Builder mergeFrom(ExportUserEventsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public ExportUserEventsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportUserEventsRequest.Builder>IOExceptionpublic 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) = { ... }
getParent in interface ExportUserEventsRequestOrBuilderpublic 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) = { ... }
getParentBytes in interface ExportUserEventsRequestOrBuilderpublic 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) = { ... }
value - The parent to set.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) = { ... }
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) = { ... }
value - The bytes for parent to set.public boolean hasOutputConfig()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
hasOutputConfig in interface ExportUserEventsRequestOrBuilderpublic OutputConfig getOutputConfig()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
getOutputConfig in interface ExportUserEventsRequestOrBuilderpublic 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];
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];
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];
public ExportUserEventsRequest.Builder clearOutputConfig()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
public OutputConfig.Builder getOutputConfigBuilder()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
public OutputConfigOrBuilder getOutputConfigOrBuilder()
Required. The output location of the data.
.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
getOutputConfigOrBuilder in interface ExportUserEventsRequestOrBuilderpublic 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;getFilter in interface ExportUserEventsRequestOrBuilderpublic 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;getFilterBytes in interface ExportUserEventsRequestOrBuilderpublic 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;value - The filter to set.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;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;value - The bytes for filter to set.public final ExportUserEventsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>public final ExportUserEventsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder>Copyright © 2025 Google LLC. All rights reserved.