com.google.cloud.retail.v2alpha

Class ExportUserEventsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2alpha.ExportUserEventsRequest

All Implemented Interfaces:

ExportUserEventsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ExportUserEventsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ExportUserEventsRequestOrBuilder

 Request message for the `ExportUserEvents` method.
 

Protobuf type google.cloud.retail.v2alpha.ExportUserEventsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExportUserEventsRequest.Builder Request message for the `ExportUserEvents` method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	OUTPUT_CONFIG_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ExportUserEventsRequest	getDefaultInstance()
ExportUserEventsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() A filtering expression to specify restrictions on returned events.
com.google.protobuf.ByteString	getFilterBytes() A filtering expression to specify restrictions on returned events.
OutputConfig	getOutputConfig() Required.
OutputConfigOrBuilder	getOutputConfigOrBuilder() Required.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<ExportUserEventsRequest>	getParserForType()
int	getSerializedSize()
int	hashCode()
boolean	hasOutputConfig() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ExportUserEventsRequest.Builder	newBuilder()
static ExportUserEventsRequest.Builder	newBuilder(ExportUserEventsRequest prototype)
ExportUserEventsRequest.Builder	newBuilderForType()
protected ExportUserEventsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExportUserEventsRequest	parseDelimitedFrom(InputStream input)
static ExportUserEventsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportUserEventsRequest	parseFrom(byte[] data)
static ExportUserEventsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportUserEventsRequest	parseFrom(ByteBuffer data)
static ExportUserEventsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportUserEventsRequest	parseFrom(com.google.protobuf.ByteString data)
static ExportUserEventsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportUserEventsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ExportUserEventsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportUserEventsRequest	parseFrom(InputStream input)
static ExportUserEventsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExportUserEventsRequest>	parser()
ExportUserEventsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getParent

public String getParent()

 Required. Resource name of a
 [Catalog][google.cloud.retail.v2alpha.Catalog]. For example
 `projects/1234/locations/global/catalogs/default_catalog`
 

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

Specified by:

getParent in interface ExportUserEventsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. Resource name of a
 [Catalog][google.cloud.retail.v2alpha.Catalog]. For example
 `projects/1234/locations/global/catalogs/default_catalog`
 

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

Specified by:

getParentBytes in interface ExportUserEventsRequestOrBuilder

Returns:

The bytes for parent.

hasOutputConfig

public boolean hasOutputConfig()

 Required. The output location of the data.
 

.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasOutputConfig in interface ExportUserEventsRequestOrBuilder

Returns:

Whether the outputConfig field is set.

getOutputConfig

public OutputConfig getOutputConfig()

 Required. The output location of the data.
 

.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getOutputConfig in interface ExportUserEventsRequestOrBuilder

Returns:

The outputConfig.

getOutputConfigOrBuilder

public OutputConfigOrBuilder getOutputConfigOrBuilder()

 Required. The output location of the data.
 

.google.cloud.retail.v2alpha.OutputConfig output_config = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getOutputConfigOrBuilder in interface ExportUserEventsRequestOrBuilder

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:

    * `eventTime`: This can be specified twice, once with a
      less than operator and once with a greater than operator. The
      `eventTime` restriction should result in one, contiguous, valid,
      `eventTime` range.

    * `eventType`: Boolean operators `OR` and `NOT` are supported if the
      expression is enclosed in parentheses and the operators are separated
      from the tag values by a space.

    * `eventsMissingCatalogItems`: 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;

Specified by:

getFilter in interface ExportUserEventsRequestOrBuilder

Returns:

The filter.

getFilterBytes

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

    * `eventTime`: This can be specified twice, once with a
      less than operator and once with a greater than operator. The
      `eventTime` restriction should result in one, contiguous, valid,
      `eventTime` range.

    * `eventType`: Boolean operators `OR` and `NOT` are supported if the
      expression is enclosed in parentheses and the operators are separated
      from the tag values by a space.

    * `eventsMissingCatalogItems`: 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;

Specified by:

getFilterBytes in interface ExportUserEventsRequestOrBuilder

Returns:

The bytes for filter.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ExportUserEventsRequest parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportUserEventsRequest parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportUserEventsRequest parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportUserEventsRequest parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportUserEventsRequest parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportUserEventsRequest parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportUserEventsRequest parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static ExportUserEventsRequest parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExportUserEventsRequest parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExportUserEventsRequest parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static ExportUserEventsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static ExportUserEventsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public ExportUserEventsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ExportUserEventsRequest.Builder newBuilder()

newBuilder

public static ExportUserEventsRequest.Builder newBuilder(ExportUserEventsRequest prototype)

toBuilder

public ExportUserEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ExportUserEventsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ExportUserEventsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ExportUserEventsRequest> parser()

getParserForType

public com.google.protobuf.Parser<ExportUserEventsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ExportUserEventsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder