- 2.54.0 (latest)
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class ExportUserEventsRequest.Builder extends GeneratedMessageV3.Builder<ExportUserEventsRequest.Builder> implements ExportUserEventsRequestOrBuilder Request message for the ExportUserEvents method.
Protobuf type google.cloud.retail.v2beta.ExportUserEventsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportUserEventsRequest.BuilderImplements
ExportUserEventsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExportUserEventsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
|
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 |
|
clearField(Descriptors.FieldDescriptor field)
public ExportUserEventsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
|
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:
* <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 |
ExportUserEventsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExportUserEventsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
|
clearOutputConfig()
public ExportUserEventsRequest.Builder clearOutputConfig()Required. The output location of the data.
.google.cloud.retail.v2beta.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. |
clone()
public ExportUserEventsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
|
getDefaultInstanceForType()
public ExportUserEventsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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:
* <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 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:
* <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 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. |
getOutputConfigBuilder()
public OutputConfig.Builder getOutputConfigBuilder()Required. The output location of the data.
.google.cloud.retail.v2beta.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.v2beta.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.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the outputConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExportUserEventsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
|
mergeOutputConfig(OutputConfig value)
public ExportUserEventsRequest.Builder mergeOutputConfig(OutputConfig value)Required. The output location of the data.
.google.cloud.retail.v2beta.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
OutputConfig |
| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExportUserEventsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ExportUserEventsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| 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:
* <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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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:
* <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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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.v2beta.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.v2beta.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 |
StringThe 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 |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExportUserEventsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ExportUserEventsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportUserEventsRequest.Builder |
|