com.google.cloud.discoveryengine.v1

Class CollectUserEventRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessage.Builder<CollectUserEventRequest.Builder>

com.google.cloud.discoveryengine.v1.CollectUserEventRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

CollectUserEventRequest

public static final class CollectUserEventRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<CollectUserEventRequest.Builder>
implements CollectUserEventRequestOrBuilder

 Request message for CollectUserEvent method.
 

Protobuf type google.cloud.discoveryengine.v1.CollectUserEventRequest

Method Summary

Modifier and Type	Method and Description
CollectUserEventRequest	build()
CollectUserEventRequest	buildPartial()
CollectUserEventRequest.Builder	clear()
CollectUserEventRequest.Builder	clearEts() The event timestamp in milliseconds.
CollectUserEventRequest.Builder	clearParent() Required.
CollectUserEventRequest.Builder	clearUri() The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
CollectUserEventRequest.Builder	clearUserEvent() Required.
CollectUserEventRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
long	getEts() The event timestamp in milliseconds.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
String	getUri() The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
com.google.protobuf.ByteString	getUriBytes() The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
String	getUserEvent() Required.
com.google.protobuf.ByteString	getUserEventBytes() Required.
boolean	hasEts() The event timestamp in milliseconds.
boolean	hasUri() The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
CollectUserEventRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
CollectUserEventRequest.Builder	mergeFrom(CollectUserEventRequest other)
CollectUserEventRequest.Builder	mergeFrom(com.google.protobuf.Message other)
CollectUserEventRequest.Builder	setEts(long value) The event timestamp in milliseconds.
CollectUserEventRequest.Builder	setParent(String value) Required.
CollectUserEventRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.
CollectUserEventRequest.Builder	setUri(String value) The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
CollectUserEventRequest.Builder	setUriBytes(com.google.protobuf.ByteString value) The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
CollectUserEventRequest.Builder	setUserEvent(String value) Required.
CollectUserEventRequest.Builder	setUserEventBytes(com.google.protobuf.ByteString value) Required.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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.MessageOrBuilder

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

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

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CollectUserEventRequest.Builder>

clear

public CollectUserEventRequest.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.GeneratedMessage.Builder<CollectUserEventRequest.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.GeneratedMessage.Builder<CollectUserEventRequest.Builder>

getDefaultInstanceForType

public CollectUserEventRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public CollectUserEventRequest build()

Specified by:

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

Specified by:

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

buildPartial

public CollectUserEventRequest buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public CollectUserEventRequest.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<CollectUserEventRequest.Builder>

mergeFrom

public CollectUserEventRequest.Builder mergeFrom(CollectUserEventRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<CollectUserEventRequest.Builder>

mergeFrom

public CollectUserEventRequest.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<CollectUserEventRequest.Builder>

Throws:

IOException

getParent

public String getParent()

 Required. The parent resource name.
 If the collect user event action is applied in
 [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
 is:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
 If the collect user event action is applied in
 [Location][google.cloud.location.Location] level, for example, the event
 with [Document][google.cloud.discoveryengine.v1.Document] across multiple
 [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
 `projects/{project}/locations/{location}`.
 

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

Specified by:

getParent in interface CollectUserEventRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The parent resource name.
 If the collect user event action is applied in
 [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
 is:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
 If the collect user event action is applied in
 [Location][google.cloud.location.Location] level, for example, the event
 with [Document][google.cloud.discoveryengine.v1.Document] across multiple
 [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
 `projects/{project}/locations/{location}`.
 

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

Specified by:

getParentBytes in interface CollectUserEventRequestOrBuilder

Returns:

The bytes for parent.

setParent

public CollectUserEventRequest.Builder setParent(String value)

 Required. The parent resource name.
 If the collect user event action is applied in
 [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
 is:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
 If the collect user event action is applied in
 [Location][google.cloud.location.Location] level, for example, the event
 with [Document][google.cloud.discoveryengine.v1.Document] across multiple
 [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
 `projects/{project}/locations/{location}`.
 

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 CollectUserEventRequest.Builder clearParent()

 Required. The parent resource name.
 If the collect user event action is applied in
 [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
 is:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
 If the collect user event action is applied in
 [Location][google.cloud.location.Location] level, for example, the event
 with [Document][google.cloud.discoveryengine.v1.Document] across multiple
 [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
 `projects/{project}/locations/{location}`.
 

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

Returns:

This builder for chaining.

setParentBytes

public CollectUserEventRequest.Builder setParentBytes(com.google.protobuf.ByteString value)

 Required. The parent resource name.
 If the collect user event action is applied in
 [DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
 is:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
 If the collect user event action is applied in
 [Location][google.cloud.location.Location] level, for example, the event
 with [Document][google.cloud.discoveryengine.v1.Document] across multiple
 [DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
 `projects/{project}/locations/{location}`.
 

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.

getUserEvent

public String getUserEvent()

 Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
 

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getUserEvent in interface CollectUserEventRequestOrBuilder

Returns:

The userEvent.

getUserEventBytes

public com.google.protobuf.ByteString getUserEventBytes()

 Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
 

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getUserEventBytes in interface CollectUserEventRequestOrBuilder

Returns:

The bytes for userEvent.

setUserEvent

public CollectUserEventRequest.Builder setUserEvent(String value)

 Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
 

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The userEvent to set.

Returns:

This builder for chaining.

clearUserEvent

public CollectUserEventRequest.Builder clearUserEvent()

 Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
 

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

This builder for chaining.

setUserEventBytes

public CollectUserEventRequest.Builder setUserEventBytes(com.google.protobuf.ByteString value)

 Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
 

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The bytes for userEvent to set.

Returns:

This builder for chaining.

hasUri

public boolean hasUri()

 The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for third-party
 requests.
 

optional string uri = 3;

Specified by:

hasUri in interface CollectUserEventRequestOrBuilder

Returns:

Whether the uri field is set.

getUri

public String getUri()

 The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for third-party
 requests.
 

optional string uri = 3;

Specified by:

getUri in interface CollectUserEventRequestOrBuilder

Returns:

The uri.

getUriBytes

public com.google.protobuf.ByteString getUriBytes()

 The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for third-party
 requests.
 

optional string uri = 3;

Specified by:

getUriBytes in interface CollectUserEventRequestOrBuilder

Returns:

The bytes for uri.

setUri

public CollectUserEventRequest.Builder setUri(String value)

 The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for third-party
 requests.
 

optional string uri = 3;

Parameters:

value - The uri to set.

Returns:

This builder for chaining.

clearUri

public CollectUserEventRequest.Builder clearUri()

 The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for third-party
 requests.
 

optional string uri = 3;

Returns:

This builder for chaining.

setUriBytes

public CollectUserEventRequest.Builder setUriBytes(com.google.protobuf.ByteString value)

 The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for third-party
 requests.
 

optional string uri = 3;

Parameters:

value - The bytes for uri to set.

Returns:

This builder for chaining.

hasEts

public boolean hasEts()

 The event timestamp in milliseconds. This prevents browser caching of
 otherwise identical get requests. The name is abbreviated to reduce the
 payload bytes.
 

optional int64 ets = 4;

Specified by:

hasEts in interface CollectUserEventRequestOrBuilder

Returns:

Whether the ets field is set.

getEts

public long getEts()

 The event timestamp in milliseconds. This prevents browser caching of
 otherwise identical get requests. The name is abbreviated to reduce the
 payload bytes.
 

optional int64 ets = 4;

Specified by:

getEts in interface CollectUserEventRequestOrBuilder

Returns:

The ets.

setEts

public CollectUserEventRequest.Builder setEts(long value)

 The event timestamp in milliseconds. This prevents browser caching of
 otherwise identical get requests. The name is abbreviated to reduce the
 payload bytes.
 

optional int64 ets = 4;

Parameters:

value - The ets to set.

Returns:

This builder for chaining.

clearEts

public CollectUserEventRequest.Builder clearEts()

 The event timestamp in milliseconds. This prevents browser caching of
 otherwise identical get requests. The name is abbreviated to reduce the
 payload bytes.
 

optional int64 ets = 4;

Returns:

This builder for chaining.