Class ListUserEventsRequest.Builder (0.21.0)

public static final class ListUserEventsRequest.Builder extends GeneratedMessageV3.Builder<ListUserEventsRequest.Builder> implements ListUserEventsRequestOrBuilder

Request message for ListUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListUserEventsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides

build()

public ListUserEventsRequest build()
Returns
TypeDescription
ListUserEventsRequest

buildPartial()

public ListUserEventsRequest buildPartial()
Returns
TypeDescription
ListUserEventsRequest

clear()

public ListUserEventsRequest.Builder clear()
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListUserEventsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides

clearFilter()

public ListUserEventsRequest.Builder clearFilter()

Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields:

  • eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range.
  • eventType: only 1 eventType restriction can be specified.
  • eventsMissingCatalogItems: specififying this will restrict 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 = search eventTime < "2018-04-23T18:30:43.511Z"
    • Example 4: eventTime > "2012-04-23T18:25:43.511Z"
    • Example 5: eventType = search
    • Example 6: eventsMissingCatalogItems

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListUserEventsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides

clearPageSize()

public ListUserEventsRequest.Builder clearPageSize()

Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

clearPageToken()

public ListUserEventsRequest.Builder clearPageToken()

Optional. The previous ListUserEventsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

clearParent()

public ListUserEventsRequest.Builder clearParent()

Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

clone()

public ListUserEventsRequest.Builder clone()
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListUserEventsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListUserEventsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields:

  • eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range.
  • eventType: only 1 eventType restriction can be specified.
  • eventsMissingCatalogItems: specififying this will restrict 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 = search eventTime < "2018-04-23T18:30:43.511Z"
    • Example 4: eventTime > "2012-04-23T18:25:43.511Z"
    • Example 5: eventType = search
    • Example 6: eventsMissingCatalogItems

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields:

  • eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range.
  • eventType: only 1 eventType restriction can be specified.
  • eventsMissingCatalogItems: specififying this will restrict 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 = search eventTime < "2018-04-23T18:30:43.511Z"
    • Example 4: eventTime > "2012-04-23T18:25:43.511Z"
    • Example 5: eventType = search
    • Example 6: eventsMissingCatalogItems

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The previous ListUserEventsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The previous ListUserEventsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListUserEventsRequest other)

public ListUserEventsRequest.Builder mergeFrom(ListUserEventsRequest other)
Parameter
NameDescription
otherListUserEventsRequest
Returns
TypeDescription
ListUserEventsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListUserEventsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListUserEventsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListUserEventsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListUserEventsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides

setFilter(String value)

public ListUserEventsRequest.Builder setFilter(String value)

Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields:

  • eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range.
  • eventType: only 1 eventType restriction can be specified.
  • eventsMissingCatalogItems: specififying this will restrict 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 = search eventTime < "2018-04-23T18:30:43.511Z"
    • Example 4: eventTime > "2012-04-23T18:25:43.511Z"
    • Example 5: eventType = search
    • Example 6: eventsMissingCatalogItems

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListUserEventsRequest.Builder setFilterBytes(ByteString value)

Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields:

  • eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range.
  • eventType: only 1 eventType restriction can be specified.
  • eventsMissingCatalogItems: specififying this will restrict 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 = search eventTime < "2018-04-23T18:30:43.511Z"
    • Example 4: eventTime > "2012-04-23T18:25:43.511Z"
    • Example 5: eventType = search
    • Example 6: eventsMissingCatalogItems

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListUserEventsRequest.Builder setPageSize(int value)

Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListUserEventsRequest.Builder setPageToken(String value)

Optional. The previous ListUserEventsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListUserEventsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The previous ListUserEventsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

setParent(String value)

public ListUserEventsRequest.Builder setParent(String value)

Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListUserEventsRequest.Builder setParentBytes(ByteString value)

Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListUserEventsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListUserEventsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListUserEventsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListUserEventsRequest.Builder
Overrides