Package com.google.cloud.recommendationengine.v1beta1

Class ListUserEventsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

com.google.cloud.recommendationengine.v1beta1.ListUserEventsRequest.Builder

All Implemented Interfaces:

ListUserEventsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListUserEventsRequest

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

 Request message for ListUserEvents method.
 

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsRequest

Method Summary

Modifier and Type	Method	Description
ListUserEventsRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListUserEventsRequest	build()
ListUserEventsRequest	buildPartial()
ListUserEventsRequest.Builder	clear()
ListUserEventsRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ListUserEventsRequest.Builder	clearFilter()	Optional.
ListUserEventsRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ListUserEventsRequest.Builder	clearPageSize()	Optional.
ListUserEventsRequest.Builder	clearPageToken()	Optional.
ListUserEventsRequest.Builder	clearParent()	Required.
ListUserEventsRequest.Builder	clone()
ListUserEventsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter()	Optional.
com.google.protobuf.ByteString	getFilterBytes()	Optional.
int	getPageSize()	Optional.
String	getPageToken()	Optional.
com.google.protobuf.ByteString	getPageTokenBytes()	Optional.
String	getParent()	Required.
com.google.protobuf.ByteString	getParentBytes()	Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListUserEventsRequest.Builder	mergeFrom(ListUserEventsRequest other)
ListUserEventsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListUserEventsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListUserEventsRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ListUserEventsRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ListUserEventsRequest.Builder	setFilter(String value)	Optional.
ListUserEventsRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value)	Optional.
ListUserEventsRequest.Builder	setPageSize(int value)	Optional.
ListUserEventsRequest.Builder	setPageToken(String value)	Optional.
ListUserEventsRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value)	Optional.
ListUserEventsRequest.Builder	setParent(String value)	Required.
ListUserEventsRequest.Builder	setParentBytes(com.google.protobuf.ByteString value)	Required.
ListUserEventsRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ListUserEventsRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

clear

public ListUserEventsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

getDefaultInstanceForType

public ListUserEventsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListUserEventsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ListUserEventsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ListUserEventsRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

setField

public ListUserEventsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

clearField

public ListUserEventsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

clearOneof

public ListUserEventsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

setRepeatedField

public ListUserEventsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

addRepeatedField

public ListUserEventsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

mergeFrom

public ListUserEventsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListUserEventsRequest.Builder>

mergeFrom

public ListUserEventsRequest.Builder mergeFrom(ListUserEventsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

mergeFrom

public ListUserEventsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListUserEventsRequest.Builder>

Throws:

IOException

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) = { ... }

Specified by:

getParent in interface ListUserEventsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.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) = { ... }

Specified by:

getParentBytes in interface ListUserEventsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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) = { ... }

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

public ListUserEventsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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];

Specified by:

getPageSize in interface ListUserEventsRequestOrBuilder

Returns:

The pageSize.

setPageSize

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];

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

getPageToken

public String getPageToken()

 Optional. The previous ListUserEventsResponse.next_page_token.
 

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

Specified by:

getPageToken in interface ListUserEventsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 Optional. The previous ListUserEventsResponse.next_page_token.
 

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

Specified by:

getPageTokenBytes in interface ListUserEventsRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListUserEventsRequest.Builder setPageToken(String value)

 Optional. The previous ListUserEventsResponse.next_page_token.
 

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

Parameters:

value - The pageToken to set.

Returns:

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:

This builder for chaining.

setPageTokenBytes

public ListUserEventsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 Optional. The previous ListUserEventsResponse.next_page_token.
 

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

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

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];

Specified by:

getFilter in interface ListUserEventsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.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];

Specified by:

getFilterBytes in interface ListUserEventsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

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];

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setFilterBytes

public ListUserEventsRequest.Builder setFilterBytes(com.google.protobuf.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];

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

setUnknownFields

public final ListUserEventsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>

mergeUnknownFields

public final ListUserEventsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListUserEventsRequest.Builder>