Class ExportUserEventsRequest (2.56.0)

public final class ExportUserEventsRequest extends GeneratedMessageV3 implements ExportUserEventsRequestOrBuilder

Request message for the ExportUserEvents method.

Protobuf type google.cloud.retail.v2beta.ExportUserEventsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExportUserEventsRequest

Implements

ExportUserEventsRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

Returns
Type	Description
`ExportUserEventsRequest`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static ExportUserEventsRequest.Builder newBuilder()

Returns
Type	Description
`ExportUserEventsRequest.Builder`

newBuilder(ExportUserEventsRequest prototype)

public static ExportUserEventsRequest.Builder newBuilder(ExportUserEventsRequest prototype)

Parameter
Name	Description
`prototype`	`ExportUserEventsRequest`

Returns
Type	Description
`ExportUserEventsRequest.Builder`

parseDelimitedFrom(InputStream input)

public static ExportUserEventsRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportUserEventsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static ExportUserEventsRequest parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportUserEventsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static ExportUserEventsRequest parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportUserEventsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static ExportUserEventsRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportUserEventsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static ExportUserEventsRequest parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportUserEventsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static ExportUserEventsRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportUserEventsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportUserEventsRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<ExportUserEventsRequest> parser()

Returns
Type	Description
`Parser<ExportUserEventsRequest>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public ExportUserEventsRequest getDefaultInstanceForType()

Returns
Type	Description
`ExportUserEventsRequest`

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()

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.

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.

getParserForType()

public Parser<ExportUserEventsRequest> getParserForType()

Returns
Type	Description
`Parser<ExportUserEventsRequest>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ExportUserEventsRequest.Builder newBuilderForType()

Returns
Type	Description
`ExportUserEventsRequest.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportUserEventsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`ExportUserEventsRequest.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ExportUserEventsRequest.Builder toBuilder()

Returns
Type	Description
`ExportUserEventsRequest.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`