public final class ExportUserEventsRequest extends GeneratedMessageV3 implements ExportUserEventsRequestOrBuilder
Request message for the ExportUserEvents method.
Protobuf type google.cloud.retail.v2alpha.ExportUserEventsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OUTPUT_CONFIG_FIELD_NUMBER
public static final int OUTPUT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ExportUserEventsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ExportUserEventsRequest.Builder newBuilder()
newBuilder(ExportUserEventsRequest prototype)
public static ExportUserEventsRequest.Builder newBuilder(ExportUserEventsRequest prototype)
public static ExportUserEventsRequest parseDelimitedFrom(InputStream input)
public static ExportUserEventsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ExportUserEventsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExportUserEventsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ExportUserEventsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportUserEventsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportUserEventsRequest parseFrom(CodedInputStream input)
public static ExportUserEventsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportUserEventsRequest parseFrom(InputStream input)
public static ExportUserEventsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ExportUserEventsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExportUserEventsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ExportUserEventsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ExportUserEventsRequest getDefaultInstanceForType()
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.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];
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.
|
getParserForType()
public Parser<ExportUserEventsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ExportUserEventsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExportUserEventsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ExportUserEventsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
